Completed
Branch Gutenberg/BUG/fix-editor-asset... (099b99)
by
unknown
29:37 queued 19:20
created
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/services/bootstrap/BootstrapRequestResponseObjects.php 2 patches
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -83,7 +83,7 @@
 block discarded – undo
83 83
     {
84 84
         espresso_load_required(
85 85
             'EE_Request',
86
-            EE_CORE . 'request_stack' . DS . 'EE_Request.core.php'
86
+            EE_CORE.'request_stack'.DS.'EE_Request.core.php'
87 87
         );
88 88
         $this->legacy_request = new EE_Request($_GET, $_POST, $_COOKIE, $_SERVER);
89 89
         $this->legacy_request->setRequest($this->request);
Please login to merge, or discard this patch.
Indentation   +65 added lines, -65 removed lines patch added patch discarded remove patch
@@ -25,80 +25,80 @@
 block discarded – undo
25 25
 class BootstrapRequestResponseObjects
26 26
 {
27 27
 
28
-    /**
29
-     * @type LegacyRequestInterface $legacy_request
30
-     */
31
-    protected $legacy_request;
28
+	/**
29
+	 * @type LegacyRequestInterface $legacy_request
30
+	 */
31
+	protected $legacy_request;
32 32
 
33
-    /**
34
-     * @type LoaderInterface $loader
35
-     */
36
-    protected $loader;
33
+	/**
34
+	 * @type LoaderInterface $loader
35
+	 */
36
+	protected $loader;
37 37
 
38
-    /**
39
-     * @var RequestInterface $request
40
-     */
41
-    protected $request;
38
+	/**
39
+	 * @var RequestInterface $request
40
+	 */
41
+	protected $request;
42 42
 
43
-    /**
44
-     * @var ResponseInterface $response
45
-     */
46
-    protected $response;
43
+	/**
44
+	 * @var ResponseInterface $response
45
+	 */
46
+	protected $response;
47 47
 
48 48
 
49
-    /**
50
-     * BootstrapRequestResponseObjects constructor.
51
-     *
52
-     * @param LoaderInterface $loader
53
-     */
54
-    public function __construct(LoaderInterface $loader)
55
-    {
56
-        $this->loader = $loader;
57
-    }
49
+	/**
50
+	 * BootstrapRequestResponseObjects constructor.
51
+	 *
52
+	 * @param LoaderInterface $loader
53
+	 */
54
+	public function __construct(LoaderInterface $loader)
55
+	{
56
+		$this->loader = $loader;
57
+	}
58 58
 
59 59
 
60
-    /**
61
-     * @return void
62
-     */
63
-    public function buildRequestResponse()
64
-    {
65
-        // load our Request and Response objects
66
-        $this->request = new Request($_GET, $_POST, $_COOKIE, $_SERVER);
67
-        $this->response = new Response();
68
-    }
60
+	/**
61
+	 * @return void
62
+	 */
63
+	public function buildRequestResponse()
64
+	{
65
+		// load our Request and Response objects
66
+		$this->request = new Request($_GET, $_POST, $_COOKIE, $_SERVER);
67
+		$this->response = new Response();
68
+	}
69 69
 
70 70
 
71
-    /**
72
-     * @return void
73
-     * @throws InvalidArgumentException
74
-     */
75
-    public function shareRequestResponse()
76
-    {
77
-        $this->loader->share('EventEspresso\core\services\request\Request', $this->request);
78
-        $this->loader->share('EventEspresso\core\services\request\Response', $this->response);
79
-        EE_Dependency_Map::instance()->setRequest($this->request);
80
-        EE_Dependency_Map::instance()->setResponse($this->response);
81
-    }
71
+	/**
72
+	 * @return void
73
+	 * @throws InvalidArgumentException
74
+	 */
75
+	public function shareRequestResponse()
76
+	{
77
+		$this->loader->share('EventEspresso\core\services\request\Request', $this->request);
78
+		$this->loader->share('EventEspresso\core\services\request\Response', $this->response);
79
+		EE_Dependency_Map::instance()->setRequest($this->request);
80
+		EE_Dependency_Map::instance()->setResponse($this->response);
81
+	}
82 82
 
83 83
 
84
-    /**
85
-     * @return void
86
-     * @throws InvalidArgumentException
87
-     * @throws EE_Error
88
-     */
89
-    public function setupLegacyRequest()
90
-    {
91
-        espresso_load_required(
92
-            'EE_Request',
93
-            EE_CORE . 'request_stack' . DS . 'EE_Request.core.php'
94
-        );
95
-        $this->legacy_request = new EE_Request($_GET, $_POST, $_COOKIE, $_SERVER);
96
-        $this->legacy_request->setRequest($this->request);
97
-        $this->legacy_request->admin = $this->request->isAdmin();
98
-        $this->legacy_request->ajax = $this->request->isAjax();
99
-        $this->legacy_request->front_ajax = $this->request->isFrontAjax();
100
-        EE_Dependency_Map::instance()->setLegacyRequest($this->legacy_request);
101
-        $this->loader->share('EE_Request', $this->legacy_request);
102
-        $this->loader->share('EventEspresso\core\services\request\LegacyRequestInterface', $this->legacy_request);
103
-    }
84
+	/**
85
+	 * @return void
86
+	 * @throws InvalidArgumentException
87
+	 * @throws EE_Error
88
+	 */
89
+	public function setupLegacyRequest()
90
+	{
91
+		espresso_load_required(
92
+			'EE_Request',
93
+			EE_CORE . 'request_stack' . DS . 'EE_Request.core.php'
94
+		);
95
+		$this->legacy_request = new EE_Request($_GET, $_POST, $_COOKIE, $_SERVER);
96
+		$this->legacy_request->setRequest($this->request);
97
+		$this->legacy_request->admin = $this->request->isAdmin();
98
+		$this->legacy_request->ajax = $this->request->isAjax();
99
+		$this->legacy_request->front_ajax = $this->request->isFrontAjax();
100
+		EE_Dependency_Map::instance()->setLegacyRequest($this->legacy_request);
101
+		$this->loader->share('EE_Request', $this->legacy_request);
102
+		$this->loader->share('EventEspresso\core\services\request\LegacyRequestInterface', $this->legacy_request);
103
+	}
104 104
 }
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.
modules/core_rest_api/EED_Core_Rest_Api.module.php 3 patches
Unused Use Statements   -1 removed lines patch added patch discarded remove patch
@@ -1,7 +1,6 @@
 block discarded – undo
1 1
 <?php
2 2
 
3 3
 use EventEspresso\core\domain\Domain;
4
-use EventEspresso\core\domain\entities\notifications\PersistentAdminNotice;
5 4
 use EventEspresso\core\domain\services\factories\EmailAddressFactory;
6 5
 use EventEspresso\core\domain\services\validation\email\EmailValidationException;
7 6
 use EventEspresso\core\exceptions\InvalidDataTypeException;
Please login to merge, or discard this patch.
Spacing   +46 added lines, -46 removed lines patch added patch discarded remove patch
@@ -122,7 +122,7 @@  discard block
 block discarded – undo
122 122
      */
123 123
     protected static function _set_hooks_for_changes()
124 124
     {
125
-        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
125
+        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES.'rest_api'.DS.'changes'), false);
126 126
         foreach ($folder_contents as $classname_in_namespace => $filepath) {
127 127
             // ignore the base parent class
128 128
             // and legacy named classes
@@ -131,7 +131,7 @@  discard block
 block discarded – undo
131 131
             ) {
132 132
                 continue;
133 133
             }
134
-            $full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
134
+            $full_classname = 'EventEspresso\core\libraries\rest_api\changes\\'.$classname_in_namespace;
135 135
             if (class_exists($full_classname)) {
136 136
                 $instance_of_class = new $full_classname;
137 137
                 if ($instance_of_class instanceof ChangesInBase) {
@@ -176,10 +176,10 @@  discard block
 block discarded – undo
176 176
                      * }
177 177
                      */
178 178
                     // skip route options
179
-                    if (! is_numeric($endpoint_key)) {
179
+                    if ( ! is_numeric($endpoint_key)) {
180 180
                         continue;
181 181
                     }
182
-                    if (! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) {
182
+                    if ( ! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) {
183 183
                         throw new EE_Error(
184 184
                             esc_html__(
185 185
                             // @codingStandardsIgnoreStart
@@ -200,7 +200,7 @@  discard block
 block discarded – undo
200 200
                     }
201 201
                     if (isset($data_for_single_endpoint['callback_args'])) {
202 202
                         $callback_args = $data_for_single_endpoint['callback_args'];
203
-                        $single_endpoint_args['callback'] = function (\WP_REST_Request $request) use (
203
+                        $single_endpoint_args['callback'] = function(\WP_REST_Request $request) use (
204 204
                             $callback,
205 205
                             $callback_args
206 206
                         ) {
@@ -219,7 +219,7 @@  discard block
 block discarded – undo
219 219
                     $schema_route_data = $data_for_multiple_endpoints['schema'];
220 220
                     $schema_callback = $schema_route_data['schema_callback'];
221 221
                     $callback_args = $schema_route_data['callback_args'];
222
-                    $multiple_endpoint_args['schema'] = function () use ($schema_callback, $callback_args) {
222
+                    $multiple_endpoint_args['schema'] = function() use ($schema_callback, $callback_args) {
223 223
                         return call_user_func_array(
224 224
                             $schema_callback,
225 225
                             $callback_args
@@ -261,7 +261,7 @@  discard block
 block discarded – undo
261 261
     {
262 262
         // delete the saved EE REST API routes
263 263
         foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
264
-            delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
264
+            delete_option(EED_Core_Rest_Api::saved_routes_option_names.$version);
265 265
         }
266 266
     }
267 267
 
@@ -280,7 +280,7 @@  discard block
 block discarded – undo
280 280
     {
281 281
         $ee_routes = array();
282 282
         foreach (self::versions_served() as $version => $hidden_endpoints) {
283
-            $ee_routes[ self::ee_api_namespace . $version ] = self::_get_ee_route_data_for_version(
283
+            $ee_routes[self::ee_api_namespace.$version] = self::_get_ee_route_data_for_version(
284 284
                 $version,
285 285
                 $hidden_endpoints
286 286
             );
@@ -300,8 +300,8 @@  discard block
 block discarded – undo
300 300
      */
301 301
     protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
302 302
     {
303
-        $ee_routes = get_option(self::saved_routes_option_names . $version, null);
304
-        if (! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
303
+        $ee_routes = get_option(self::saved_routes_option_names.$version, null);
304
+        if ( ! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
305 305
             $ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
306 306
         }
307 307
         return $ee_routes;
@@ -328,7 +328,7 @@  discard block
 block discarded – undo
328 328
                 $instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
329 329
             )
330 330
         );
331
-        $option_name = self::saved_routes_option_names . $version;
331
+        $option_name = self::saved_routes_option_names.$version;
332 332
         if (get_option($option_name)) {
333 333
             update_option($option_name, $routes, true);
334 334
         } else {
@@ -373,8 +373,8 @@  discard block
 block discarded – undo
373 373
     {
374 374
         $model_routes = array();
375 375
         foreach (self::versions_served() as $version => $hidden_endpoint) {
376
-            $model_routes[ EED_Core_Rest_Api::ee_api_namespace
377
-                           . $version ] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
376
+            $model_routes[EED_Core_Rest_Api::ee_api_namespace
377
+                           . $version] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
378 378
         }
379 379
         return $model_routes;
380 380
     }
@@ -443,13 +443,13 @@  discard block
 block discarded – undo
443 443
         foreach (EED_Core_Rest_Api::model_names_with_plural_routes($version) as $model_name => $model_classname) {
444 444
             $model = \EE_Registry::instance()->load_model($model_name);
445 445
             // if this isn't a valid model then let's skip iterate to the next item in the loop.
446
-            if (! $model instanceof EEM_Base) {
446
+            if ( ! $model instanceof EEM_Base) {
447 447
                 continue;
448 448
             }
449 449
             // yes we could just register one route for ALL models, but then they wouldn't show up in the index
450 450
             $plural_model_route = EED_Core_Rest_Api::get_collection_route($model);
451 451
             $singular_model_route = EED_Core_Rest_Api::get_entity_route($model, '(?P<id>[^\/]+)');
452
-            $model_routes[ $plural_model_route ] = array(
452
+            $model_routes[$plural_model_route] = array(
453 453
                 array(
454 454
                     'callback'        => array(
455 455
                         'EventEspresso\core\libraries\rest_api\controllers\model\Read',
@@ -460,7 +460,7 @@  discard block
 block discarded – undo
460 460
                     'hidden_endpoint' => $hidden_endpoint,
461 461
                     'args'            => $this->_get_read_query_params($model, $version),
462 462
                     '_links'          => array(
463
-                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
463
+                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace.$version.$singular_model_route),
464 464
                     ),
465 465
                 ),
466 466
                 'schema' => array(
@@ -471,7 +471,7 @@  discard block
 block discarded – undo
471 471
                     'callback_args'   => array($version, $model_name),
472 472
                 ),
473 473
             );
474
-            $model_routes[ $singular_model_route ] = array(
474
+            $model_routes[$singular_model_route] = array(
475 475
                 array(
476 476
                     'callback'        => array(
477 477
                         'EventEspresso\core\libraries\rest_api\controllers\model\Read',
@@ -488,7 +488,7 @@  discard block
 block discarded – undo
488 488
                 EED_Core_Rest_Api::should_have_write_endpoints($model),
489 489
                 $model
490 490
             )) {
491
-                $model_routes[ $plural_model_route ][] = array(
491
+                $model_routes[$plural_model_route][] = array(
492 492
                     'callback'        => array(
493 493
                         'EventEspresso\core\libraries\rest_api\controllers\model\Write',
494 494
                         'handleRequestInsert',
@@ -498,8 +498,8 @@  discard block
 block discarded – undo
498 498
                     'hidden_endpoint' => $hidden_endpoint,
499 499
                     'args'            => $this->_get_write_params($model_name, $model_version_info, true),
500 500
                 );
501
-                $model_routes[ $singular_model_route ] = array_merge(
502
-                    $model_routes[ $singular_model_route ],
501
+                $model_routes[$singular_model_route] = array_merge(
502
+                    $model_routes[$singular_model_route],
503 503
                     array(
504 504
                         array(
505 505
                             'callback'        => array(
@@ -542,7 +542,7 @@  discard block
 block discarded – undo
542 542
                         'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
543 543
                     ),
544 544
                 );
545
-                $model_routes[ $related_route ] = $endpoints;
545
+                $model_routes[$related_route] = $endpoints;
546 546
             }
547 547
         }
548 548
         return $model_routes;
@@ -574,7 +574,7 @@  discard block
 block discarded – undo
574 574
      */
575 575
     public static function get_entity_route($model, $id)
576 576
     {
577
-        return EED_Core_Rest_Api::get_collection_route($model) . '/' . $id;
577
+        return EED_Core_Rest_Api::get_collection_route($model).'/'.$id;
578 578
     }
579 579
 
580 580
 
@@ -594,7 +594,7 @@  discard block
 block discarded – undo
594 594
             $relation_obj->get_other_model()->get_this_model_name(),
595 595
             $relation_obj
596 596
         );
597
-        return EED_Core_Rest_Api::get_entity_route($model, $id) . '/' . $related_model_name_endpoint_part;
597
+        return EED_Core_Rest_Api::get_entity_route($model, $id).'/'.$related_model_name_endpoint_part;
598 598
     }
599 599
 
600 600
 
@@ -608,7 +608,7 @@  discard block
 block discarded – undo
608 608
      */
609 609
     public static function get_versioned_route_to($relative_route, $version = '4.8.36')
610 610
     {
611
-        return '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/' . $relative_route;
611
+        return '/'.EED_Core_Rest_Api::ee_api_namespace.$version.'/'.$relative_route;
612 612
     }
613 613
 
614 614
 
@@ -622,7 +622,7 @@  discard block
 block discarded – undo
622 622
     {
623 623
         $routes = array();
624 624
         foreach (self::versions_served() as $version => $hidden_endpoint) {
625
-            $routes[ self::ee_api_namespace . $version ] = $this->_get_rpc_route_data_for_version(
625
+            $routes[self::ee_api_namespace.$version] = $this->_get_rpc_route_data_for_version(
626 626
                 $version,
627 627
                 $hidden_endpoint
628 628
             );
@@ -748,7 +748,7 @@  discard block
 block discarded – undo
748 748
     {
749 749
         $default_orderby = array();
750 750
         foreach ($model->get_combined_primary_key_fields() as $key_field) {
751
-            $default_orderby[ $key_field->get_name() ] = 'ASC';
751
+            $default_orderby[$key_field->get_name()] = 'ASC';
752 752
         }
753 753
         return array_merge(
754 754
             $this->_get_response_selection_query_params($model, $version),
@@ -782,7 +782,7 @@  discard block
 block discarded – undo
782 782
                     'type'              => array(
783 783
                         'object',
784 784
                         'string',
785
-                    ),// because we accept a variety of types, WP core validation and sanitization
785
+                    ), // because we accept a variety of types, WP core validation and sanitization
786 786
                     // freaks out. We'll just validate this argument while handling the request
787 787
                     'validate_callback' => null,
788 788
                     'sanitize_callback' => null,
@@ -880,7 +880,7 @@  discard block
 block discarded – undo
880 880
                 $sanitize_callback = null;
881 881
             }
882 882
             $arg_info['sanitize_callback'] = $sanitize_callback;
883
-            $args_info[ $field_name ] = $arg_info;
883
+            $args_info[$field_name] = $arg_info;
884 884
             if ($field_obj instanceof EE_Datetime_Field) {
885 885
                 $gmt_arg_info = $arg_info;
886 886
                 $gmt_arg_info['description'] = sprintf(
@@ -891,7 +891,7 @@  discard block
 block discarded – undo
891 891
                     $field_obj->get_nicename(),
892 892
                     $field_name
893 893
                 );
894
-                $args_info[ $field_name . '_gmt' ] = $gmt_arg_info;
894
+                $args_info[$field_name.'_gmt'] = $gmt_arg_info;
895 895
             }
896 896
         }
897 897
         return $args_info;
@@ -914,16 +914,16 @@  discard block
 block discarded – undo
914 914
     public static function default_sanitize_callback($value, WP_REST_Request $request, $param)
915 915
     {
916 916
         $attributes = $request->get_attributes();
917
-        if (! isset($attributes['args'][ $param ])
918
-            || ! is_array($attributes['args'][ $param ])) {
917
+        if ( ! isset($attributes['args'][$param])
918
+            || ! is_array($attributes['args'][$param])) {
919 919
             $validation_result = true;
920 920
         } else {
921
-            $args = $attributes['args'][ $param ];
921
+            $args = $attributes['args'][$param];
922 922
             if ((
923 923
                     $value === ''
924 924
                     || $value === null
925 925
                 )
926
-                && (! isset($args['required'])
926
+                && ( ! isset($args['required'])
927 927
                     || $args['required'] === false
928 928
                 )
929 929
             ) {
@@ -933,7 +933,7 @@  discard block
 block discarded – undo
933 933
                       && $args['format'] === 'email'
934 934
             ) {
935 935
                 $validation_result = true;
936
-                if (! self::_validate_email($value)) {
936
+                if ( ! self::_validate_email($value)) {
937 937
                     $validation_result = new WP_Error(
938 938
                         'rest_invalid_param',
939 939
                         esc_html__(
@@ -983,7 +983,7 @@  discard block
 block discarded – undo
983 983
     {
984 984
         $config_routes = array();
985 985
         foreach (self::versions_served() as $version => $hidden_endpoint) {
986
-            $config_routes[ self::ee_api_namespace . $version ] = $this->_get_config_route_data_for_version(
986
+            $config_routes[self::ee_api_namespace.$version] = $this->_get_config_route_data_for_version(
987 987
                 $version,
988 988
                 $hidden_endpoint
989 989
             );
@@ -1038,7 +1038,7 @@  discard block
 block discarded – undo
1038 1038
     {
1039 1039
         $meta_routes = array();
1040 1040
         foreach (self::versions_served() as $version => $hidden_endpoint) {
1041
-            $meta_routes[ self::ee_api_namespace . $version ] = $this->_get_meta_route_data_for_version(
1041
+            $meta_routes[self::ee_api_namespace.$version] = $this->_get_meta_route_data_for_version(
1042 1042
                 $version,
1043 1043
                 $hidden_endpoint
1044 1044
             );
@@ -1090,7 +1090,7 @@  discard block
 block discarded – undo
1090 1090
             foreach ($relative_urls as $resource_name => $endpoints) {
1091 1091
                 foreach ($endpoints as $key => $endpoint) {
1092 1092
                     // skip schema and other route options
1093
-                    if (! is_numeric($key)) {
1093
+                    if ( ! is_numeric($key)) {
1094 1094
                         continue;
1095 1095
                     }
1096 1096
                     // by default, hide "hidden_endpoint"s, unless the request indicates
@@ -1099,9 +1099,9 @@  discard block
 block discarded – undo
1099 1099
                     if (($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
1100 1100
                         || ($endpoint['hidden_endpoint'] && $force_show_ee_namespace === '')
1101 1101
                     ) {
1102
-                        $full_route = '/' . ltrim($namespace, '/');
1103
-                        $full_route .= '/' . ltrim($resource_name, '/');
1104
-                        unset($route_data[ $full_route ]);
1102
+                        $full_route = '/'.ltrim($namespace, '/');
1103
+                        $full_route .= '/'.ltrim($resource_name, '/');
1104
+                        unset($route_data[$full_route]);
1105 1105
                     }
1106 1106
                 }
1107 1107
             }
@@ -1174,19 +1174,19 @@  discard block
 block discarded – undo
1174 1174
             // if it's not above the current core version, and it's compatible with the current version of core
1175 1175
             if ($key_versioned_endpoint === $latest_version) {
1176 1176
                 // don't hide the latest version in the index
1177
-                $versions_served[ $key_versioned_endpoint ] = false;
1177
+                $versions_served[$key_versioned_endpoint] = false;
1178 1178
             } elseif ($key_versioned_endpoint >= $lowest_compatible_version
1179 1179
                 && $key_versioned_endpoint < EED_Core_Rest_Api::core_version()
1180 1180
             ) {
1181 1181
                 // include, but hide, previous versions which are still supported
1182
-                $versions_served[ $key_versioned_endpoint ] = true;
1182
+                $versions_served[$key_versioned_endpoint] = true;
1183 1183
             } elseif (apply_filters(
1184 1184
                 'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
1185 1185
                 false,
1186 1186
                 $possibly_served_versions
1187 1187
             )) {
1188 1188
                 // if a version is no longer supported, don't include it in index or list of versions served
1189
-                $versions_served[ $key_versioned_endpoint ] = true;
1189
+                $versions_served[$key_versioned_endpoint] = true;
1190 1190
             }
1191 1191
         }
1192 1192
         return $versions_served;
@@ -1244,7 +1244,7 @@  discard block
 block discarded – undo
1244 1244
         $model_names = self::model_names_with_plural_routes($version);
1245 1245
         $collection_routes = array();
1246 1246
         foreach ($model_names as $model_name => $model_class_name) {
1247
-            $collection_routes[ strtolower($model_name) ] = '/' . self::ee_api_namespace . $version . '/'
1247
+            $collection_routes[strtolower($model_name)] = '/'.self::ee_api_namespace.$version.'/'
1248 1248
                                                             . EEH_Inflector::pluralize_and_lower($model_name);
1249 1249
         }
1250 1250
         return $collection_routes;
@@ -1265,9 +1265,9 @@  discard block
 block discarded – undo
1265 1265
             $primary_keys = $model_class_name::instance()->get_combined_primary_key_fields();
1266 1266
             foreach ($primary_keys as $primary_key_name => $primary_key_field) {
1267 1267
                 if (count($primary_keys) > 1) {
1268
-                    $primary_key_items[ strtolower($model_name) ][] = $primary_key_name;
1268
+                    $primary_key_items[strtolower($model_name)][] = $primary_key_name;
1269 1269
                 } else {
1270
-                    $primary_key_items[ strtolower($model_name) ] = $primary_key_name;
1270
+                    $primary_key_items[strtolower($model_name)] = $primary_key_name;
1271 1271
                 }
1272 1272
             }
1273 1273
         }
Please login to merge, or discard this patch.
Indentation   +1264 added lines, -1264 removed lines patch added patch discarded remove patch
@@ -23,1268 +23,1268 @@
 block discarded – undo
23 23
 class EED_Core_Rest_Api extends \EED_Module
24 24
 {
25 25
 
26
-    const ee_api_namespace = Domain::API_NAMESPACE;
27
-
28
-    const ee_api_namespace_for_regex = 'ee\/v([^/]*)\/';
29
-
30
-    const saved_routes_option_names = 'ee_core_routes';
31
-
32
-    /**
33
-     * string used in _links response bodies to make them globally unique.
34
-     *
35
-     * @see http://v2.wp-api.org/extending/linking/
36
-     */
37
-    const ee_api_link_namespace = 'https://api.eventespresso.com/';
38
-
39
-    /**
40
-     * @var CalculatedModelFields
41
-     */
42
-    protected static $_field_calculator;
43
-
44
-
45
-    /**
46
-     * @return EED_Core_Rest_Api|EED_Module
47
-     */
48
-    public static function instance()
49
-    {
50
-        self::$_field_calculator = LoaderFactory::getLoader()->load('EventEspresso\core\libraries\rest_api\CalculatedModelFields');
51
-        return parent::get_instance(__CLASS__);
52
-    }
53
-
54
-
55
-    /**
56
-     *    set_hooks - for hooking into EE Core, other modules, etc
57
-     *
58
-     * @access    public
59
-     * @return    void
60
-     */
61
-    public static function set_hooks()
62
-    {
63
-        self::set_hooks_both();
64
-    }
65
-
66
-
67
-    /**
68
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
69
-     *
70
-     * @access    public
71
-     * @return    void
72
-     */
73
-    public static function set_hooks_admin()
74
-    {
75
-        self::set_hooks_both();
76
-    }
77
-
78
-
79
-    public static function set_hooks_both()
80
-    {
81
-        add_action('rest_api_init', array('EED_Core_Rest_Api', 'register_routes'), 10);
82
-        add_action('rest_api_init', array('EED_Core_Rest_Api', 'set_hooks_rest_api'), 5);
83
-        add_filter('rest_route_data', array('EED_Core_Rest_Api', 'hide_old_endpoints'), 10, 2);
84
-        add_filter(
85
-            'rest_index',
86
-            array('EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filterEeMetadataIntoIndex')
87
-        );
88
-        EED_Core_Rest_Api::invalidate_cached_route_data_on_version_change();
89
-    }
90
-
91
-
92
-    /**
93
-     * sets up hooks which only need to be included as part of REST API requests;
94
-     * other requests like to the frontend or admin etc don't need them
95
-     *
96
-     * @throws \EE_Error
97
-     */
98
-    public static function set_hooks_rest_api()
99
-    {
100
-        // set hooks which account for changes made to the API
101
-        EED_Core_Rest_Api::_set_hooks_for_changes();
102
-    }
103
-
104
-
105
-    /**
106
-     * public wrapper of _set_hooks_for_changes.
107
-     * Loads all the hooks which make requests to old versions of the API
108
-     * appear the same as they always did
109
-     *
110
-     * @throws EE_Error
111
-     */
112
-    public static function set_hooks_for_changes()
113
-    {
114
-        self::_set_hooks_for_changes();
115
-    }
116
-
117
-
118
-    /**
119
-     * Loads all the hooks which make requests to old versions of the API
120
-     * appear the same as they always did
121
-     *
122
-     * @throws EE_Error
123
-     */
124
-    protected static function _set_hooks_for_changes()
125
-    {
126
-        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
127
-        foreach ($folder_contents as $classname_in_namespace => $filepath) {
128
-            // ignore the base parent class
129
-            // and legacy named classes
130
-            if ($classname_in_namespace === 'ChangesInBase'
131
-                || strpos($classname_in_namespace, 'Changes_In_') === 0
132
-            ) {
133
-                continue;
134
-            }
135
-            $full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
136
-            if (class_exists($full_classname)) {
137
-                $instance_of_class = new $full_classname;
138
-                if ($instance_of_class instanceof ChangesInBase) {
139
-                    $instance_of_class->setHooks();
140
-                }
141
-            }
142
-        }
143
-    }
144
-
145
-
146
-    /**
147
-     * Filters the WP routes to add our EE-related ones. This takes a bit of time
148
-     * so we actually prefer to only do it when an EE plugin is activated or upgraded
149
-     *
150
-     * @throws \EE_Error
151
-     */
152
-    public static function register_routes()
153
-    {
154
-        foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_routes) {
155
-            foreach ($relative_routes as $relative_route => $data_for_multiple_endpoints) {
156
-                /**
157
-                 * @var array     $data_for_multiple_endpoints numerically indexed array
158
-                 *                                         but can also contain route options like {
159
-                 * @type array    $schema                      {
160
-                 * @type callable $schema_callback
161
-                 * @type array    $callback_args               arguments that will be passed to the callback, after the
162
-                 * WP_REST_Request of course
163
-                 * }
164
-                 * }
165
-                 */
166
-                // when registering routes, register all the endpoints' data at the same time
167
-                $multiple_endpoint_args = array();
168
-                foreach ($data_for_multiple_endpoints as $endpoint_key => $data_for_single_endpoint) {
169
-                    /**
170
-                     * @var array     $data_for_single_endpoint {
171
-                     * @type callable $callback
172
-                     * @type string methods
173
-                     * @type array args
174
-                     * @type array _links
175
-                     * @type array    $callback_args            arguments that will be passed to the callback, after the
176
-                     * WP_REST_Request of course
177
-                     * }
178
-                     */
179
-                    // skip route options
180
-                    if (! is_numeric($endpoint_key)) {
181
-                        continue;
182
-                    }
183
-                    if (! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) {
184
-                        throw new EE_Error(
185
-                            esc_html__(
186
-                            // @codingStandardsIgnoreStart
187
-                                'Endpoint configuration data needs to have entries "callback" (callable) and "methods" (comma-separated list of accepts HTTP methods).',
188
-                                // @codingStandardsIgnoreEnd
189
-                                'event_espresso'
190
-                            )
191
-                        );
192
-                    }
193
-                    $callback = $data_for_single_endpoint['callback'];
194
-                    $single_endpoint_args = array(
195
-                        'methods' => $data_for_single_endpoint['methods'],
196
-                        'args'    => isset($data_for_single_endpoint['args']) ? $data_for_single_endpoint['args']
197
-                            : array(),
198
-                    );
199
-                    if (isset($data_for_single_endpoint['_links'])) {
200
-                        $single_endpoint_args['_links'] = $data_for_single_endpoint['_links'];
201
-                    }
202
-                    if (isset($data_for_single_endpoint['callback_args'])) {
203
-                        $callback_args = $data_for_single_endpoint['callback_args'];
204
-                        $single_endpoint_args['callback'] = function (\WP_REST_Request $request) use (
205
-                            $callback,
206
-                            $callback_args
207
-                        ) {
208
-                            array_unshift($callback_args, $request);
209
-                            return call_user_func_array(
210
-                                $callback,
211
-                                $callback_args
212
-                            );
213
-                        };
214
-                    } else {
215
-                        $single_endpoint_args['callback'] = $data_for_single_endpoint['callback'];
216
-                    }
217
-                    $multiple_endpoint_args[] = $single_endpoint_args;
218
-                }
219
-                if (isset($data_for_multiple_endpoints['schema'])) {
220
-                    $schema_route_data = $data_for_multiple_endpoints['schema'];
221
-                    $schema_callback = $schema_route_data['schema_callback'];
222
-                    $callback_args = $schema_route_data['callback_args'];
223
-                    $multiple_endpoint_args['schema'] = function () use ($schema_callback, $callback_args) {
224
-                        return call_user_func_array(
225
-                            $schema_callback,
226
-                            $callback_args
227
-                        );
228
-                    };
229
-                }
230
-                register_rest_route(
231
-                    $namespace,
232
-                    $relative_route,
233
-                    $multiple_endpoint_args
234
-                );
235
-            }
236
-        }
237
-    }
238
-
239
-
240
-    /**
241
-     * Checks if there was a version change or something that merits invalidating the cached
242
-     * route data. If so, invalidates the cached route data so that it gets refreshed
243
-     * next time the WP API is used
244
-     */
245
-    public static function invalidate_cached_route_data_on_version_change()
246
-    {
247
-        if (EE_System::instance()->detect_req_type() !== EE_System::req_type_normal) {
248
-            EED_Core_Rest_Api::invalidate_cached_route_data();
249
-        }
250
-        foreach (EE_Registry::instance()->addons as $addon) {
251
-            if ($addon instanceof EE_Addon && $addon->detect_req_type() !== EE_System::req_type_normal) {
252
-                EED_Core_Rest_Api::invalidate_cached_route_data();
253
-            }
254
-        }
255
-    }
256
-
257
-
258
-    /**
259
-     * Removes the cached route data so it will get refreshed next time the WP API is used
260
-     */
261
-    public static function invalidate_cached_route_data()
262
-    {
263
-        // delete the saved EE REST API routes
264
-        foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
265
-            delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
266
-        }
267
-    }
268
-
269
-
270
-    /**
271
-     * Gets the EE route data
272
-     *
273
-     * @return array top-level key is the namespace, next-level key is the route and its value is array{
274
-     * @throws \EE_Error
275
-     * @type string|array $callback
276
-     * @type string       $methods
277
-     * @type boolean      $hidden_endpoint
278
-     * }
279
-     */
280
-    public static function get_ee_route_data()
281
-    {
282
-        $ee_routes = array();
283
-        foreach (self::versions_served() as $version => $hidden_endpoints) {
284
-            $ee_routes[ self::ee_api_namespace . $version ] = self::_get_ee_route_data_for_version(
285
-                $version,
286
-                $hidden_endpoints
287
-            );
288
-        }
289
-        return $ee_routes;
290
-    }
291
-
292
-
293
-    /**
294
-     * Gets the EE route data from the wp options if it exists already,
295
-     * otherwise re-generates it and saves it to the option
296
-     *
297
-     * @param string  $version
298
-     * @param boolean $hidden_endpoints
299
-     * @return array
300
-     * @throws \EE_Error
301
-     */
302
-    protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
303
-    {
304
-        $ee_routes = get_option(self::saved_routes_option_names . $version, null);
305
-        if (! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
306
-            $ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
307
-        }
308
-        return $ee_routes;
309
-    }
310
-
311
-
312
-    /**
313
-     * Saves the EE REST API route data to a wp option and returns it
314
-     *
315
-     * @param string  $version
316
-     * @param boolean $hidden_endpoints
317
-     * @return mixed|null
318
-     * @throws \EE_Error
319
-     */
320
-    protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
321
-    {
322
-        $instance = self::instance();
323
-        $routes = apply_filters(
324
-            'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
325
-            array_replace_recursive(
326
-                $instance->_get_config_route_data_for_version($version, $hidden_endpoints),
327
-                $instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
328
-                $instance->_get_model_route_data_for_version($version, $hidden_endpoints),
329
-                $instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
330
-            )
331
-        );
332
-        $option_name = self::saved_routes_option_names . $version;
333
-        if (get_option($option_name)) {
334
-            update_option($option_name, $routes, true);
335
-        } else {
336
-            add_option($option_name, $routes, null, 'no');
337
-        }
338
-        return $routes;
339
-    }
340
-
341
-
342
-    /**
343
-     * Calculates all the EE routes and saves it to a WordPress option so we don't
344
-     * need to calculate it on every request
345
-     *
346
-     * @deprecated since version 4.9.1
347
-     * @return void
348
-     */
349
-    public static function save_ee_routes()
350
-    {
351
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
352
-            $instance = self::instance();
353
-            $routes = apply_filters(
354
-                'EED_Core_Rest_Api__save_ee_routes__routes',
355
-                array_replace_recursive(
356
-                    $instance->_register_config_routes(),
357
-                    $instance->_register_meta_routes(),
358
-                    $instance->_register_model_routes(),
359
-                    $instance->_register_rpc_routes()
360
-                )
361
-            );
362
-            update_option(self::saved_routes_option_names, $routes, true);
363
-        }
364
-    }
365
-
366
-
367
-    /**
368
-     * Gets all the route information relating to EE models
369
-     *
370
-     * @return array @see get_ee_route_data
371
-     * @deprecated since version 4.9.1
372
-     */
373
-    protected function _register_model_routes()
374
-    {
375
-        $model_routes = array();
376
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
377
-            $model_routes[ EED_Core_Rest_Api::ee_api_namespace
378
-                           . $version ] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
379
-        }
380
-        return $model_routes;
381
-    }
382
-
383
-
384
-    /**
385
-     * Decides whether or not to add write endpoints for this model.
386
-     *
387
-     * Currently, this defaults to exclude all global tables and models
388
-     * which would allow inserting WP core data (we don't want to duplicate
389
-     * what WP API does, as it's unnecessary, extra work, and potentially extra bugs)
390
-     *
391
-     * @param EEM_Base $model
392
-     * @return bool
393
-     */
394
-    public static function should_have_write_endpoints(EEM_Base $model)
395
-    {
396
-        if ($model->is_wp_core_model()) {
397
-            return false;
398
-        }
399
-        foreach ($model->get_tables() as $table) {
400
-            if ($table->is_global()) {
401
-                return false;
402
-            }
403
-        }
404
-        return true;
405
-    }
406
-
407
-
408
-    /**
409
-     * Gets the names of all models which should have plural routes (eg `ee/v4.8.36/events`)
410
-     * in this versioned namespace of EE4
411
-     *
412
-     * @param $version
413
-     * @return array keys are model names (eg 'Event') and values ar either classnames (eg 'EEM_Event')
414
-     */
415
-    public static function model_names_with_plural_routes($version)
416
-    {
417
-        $model_version_info = new ModelVersionInfo($version);
418
-        $models_to_register = $model_version_info->modelsForRequestedVersion();
419
-        // let's not bother having endpoints for extra metas
420
-        unset(
421
-            $models_to_register['Extra_Meta'],
422
-            $models_to_register['Extra_Join'],
423
-            $models_to_register['Post_Meta']
424
-        );
425
-        return apply_filters(
426
-            'FHEE__EED_Core_REST_API___register_model_routes',
427
-            $models_to_register
428
-        );
429
-    }
430
-
431
-
432
-    /**
433
-     * Gets the route data for EE models in the specified version
434
-     *
435
-     * @param string  $version
436
-     * @param boolean $hidden_endpoint
437
-     * @return array
438
-     * @throws EE_Error
439
-     */
440
-    protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
441
-    {
442
-        $model_routes = array();
443
-        $model_version_info = new ModelVersionInfo($version);
444
-        foreach (EED_Core_Rest_Api::model_names_with_plural_routes($version) as $model_name => $model_classname) {
445
-            $model = \EE_Registry::instance()->load_model($model_name);
446
-            // if this isn't a valid model then let's skip iterate to the next item in the loop.
447
-            if (! $model instanceof EEM_Base) {
448
-                continue;
449
-            }
450
-            // yes we could just register one route for ALL models, but then they wouldn't show up in the index
451
-            $plural_model_route = EED_Core_Rest_Api::get_collection_route($model);
452
-            $singular_model_route = EED_Core_Rest_Api::get_entity_route($model, '(?P<id>[^\/]+)');
453
-            $model_routes[ $plural_model_route ] = array(
454
-                array(
455
-                    'callback'        => array(
456
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
457
-                        'handleRequestGetAll',
458
-                    ),
459
-                    'callback_args'   => array($version, $model_name),
460
-                    'methods'         => WP_REST_Server::READABLE,
461
-                    'hidden_endpoint' => $hidden_endpoint,
462
-                    'args'            => $this->_get_read_query_params($model, $version),
463
-                    '_links'          => array(
464
-                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
465
-                    ),
466
-                ),
467
-                'schema' => array(
468
-                    'schema_callback' => array(
469
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
470
-                        'handleSchemaRequest',
471
-                    ),
472
-                    'callback_args'   => array($version, $model_name),
473
-                ),
474
-            );
475
-            $model_routes[ $singular_model_route ] = array(
476
-                array(
477
-                    'callback'        => array(
478
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
479
-                        'handleRequestGetOne',
480
-                    ),
481
-                    'callback_args'   => array($version, $model_name),
482
-                    'methods'         => WP_REST_Server::READABLE,
483
-                    'hidden_endpoint' => $hidden_endpoint,
484
-                    'args'            => $this->_get_response_selection_query_params($model, $version),
485
-                ),
486
-            );
487
-            if (apply_filters(
488
-                'FHEE__EED_Core_Rest_Api___get_model_route_data_for_version__add_write_endpoints',
489
-                EED_Core_Rest_Api::should_have_write_endpoints($model),
490
-                $model
491
-            )) {
492
-                $model_routes[ $plural_model_route ][] = array(
493
-                    'callback'        => array(
494
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Write',
495
-                        'handleRequestInsert',
496
-                    ),
497
-                    'callback_args'   => array($version, $model_name),
498
-                    'methods'         => WP_REST_Server::CREATABLE,
499
-                    'hidden_endpoint' => $hidden_endpoint,
500
-                    'args'            => $this->_get_write_params($model_name, $model_version_info, true),
501
-                );
502
-                $model_routes[ $singular_model_route ] = array_merge(
503
-                    $model_routes[ $singular_model_route ],
504
-                    array(
505
-                        array(
506
-                            'callback'        => array(
507
-                                'EventEspresso\core\libraries\rest_api\controllers\model\Write',
508
-                                'handleRequestUpdate',
509
-                            ),
510
-                            'callback_args'   => array($version, $model_name),
511
-                            'methods'         => WP_REST_Server::EDITABLE,
512
-                            'hidden_endpoint' => $hidden_endpoint,
513
-                            'args'            => $this->_get_write_params($model_name, $model_version_info),
514
-                        ),
515
-                        array(
516
-                            'callback'        => array(
517
-                                'EventEspresso\core\libraries\rest_api\controllers\model\Write',
518
-                                'handleRequestDelete',
519
-                            ),
520
-                            'callback_args'   => array($version, $model_name),
521
-                            'methods'         => WP_REST_Server::DELETABLE,
522
-                            'hidden_endpoint' => $hidden_endpoint,
523
-                            'args'            => $this->_get_delete_query_params($model, $version),
524
-                        ),
525
-                    )
526
-                );
527
-            }
528
-            foreach ($model->relation_settings() as $relation_name => $relation_obj) {
529
-                $related_route = EED_Core_Rest_Api::get_relation_route_via(
530
-                    $model,
531
-                    '(?P<id>[^\/]+)',
532
-                    $relation_obj
533
-                );
534
-                $endpoints = array(
535
-                    array(
536
-                        'callback'        => array(
537
-                            'EventEspresso\core\libraries\rest_api\controllers\model\Read',
538
-                            'handleRequestGetRelated',
539
-                        ),
540
-                        'callback_args'   => array($version, $model_name, $relation_name),
541
-                        'methods'         => WP_REST_Server::READABLE,
542
-                        'hidden_endpoint' => $hidden_endpoint,
543
-                        'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
544
-                    ),
545
-                );
546
-                $model_routes[ $related_route ] = $endpoints;
547
-            }
548
-        }
549
-        return $model_routes;
550
-    }
551
-
552
-
553
-    /**
554
-     * Gets the relative URI to a model's REST API plural route, after the EE4 versioned namespace,
555
-     * excluding the preceding slash.
556
-     * Eg you pass get_plural_route_to('Event') = 'events'
557
-     *
558
-     * @param EEM_Base $model
559
-     * @return string
560
-     */
561
-    public static function get_collection_route(EEM_Base $model)
562
-    {
563
-        return EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
564
-    }
565
-
566
-
567
-    /**
568
-     * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
569
-     * excluding the preceding slash.
570
-     * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
571
-     *
572
-     * @param EEM_Base $model eg Event or Venue
573
-     * @param string   $id
574
-     * @return string
575
-     */
576
-    public static function get_entity_route($model, $id)
577
-    {
578
-        return EED_Core_Rest_Api::get_collection_route($model) . '/' . $id;
579
-    }
580
-
581
-
582
-    /**
583
-     * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
584
-     * excluding the preceding slash.
585
-     * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
586
-     *
587
-     * @param EEM_Base               $model eg Event or Venue
588
-     * @param string                 $id
589
-     * @param EE_Model_Relation_Base $relation_obj
590
-     * @return string
591
-     */
592
-    public static function get_relation_route_via(EEM_Base $model, $id, EE_Model_Relation_Base $relation_obj)
593
-    {
594
-        $related_model_name_endpoint_part = ModelRead::getRelatedEntityName(
595
-            $relation_obj->get_other_model()->get_this_model_name(),
596
-            $relation_obj
597
-        );
598
-        return EED_Core_Rest_Api::get_entity_route($model, $id) . '/' . $related_model_name_endpoint_part;
599
-    }
600
-
601
-
602
-    /**
603
-     * Adds onto the $relative_route the EE4 REST API versioned namespace.
604
-     * Eg if given '4.8.36' and 'events', will return 'ee/v4.8.36/events'
605
-     *
606
-     * @param string $relative_route
607
-     * @param string $version
608
-     * @return string
609
-     */
610
-    public static function get_versioned_route_to($relative_route, $version = '4.8.36')
611
-    {
612
-        return '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/' . $relative_route;
613
-    }
614
-
615
-
616
-    /**
617
-     * Adds all the RPC-style routes (remote procedure call-like routes, ie
618
-     * routes that don't conform to the traditional REST CRUD-style).
619
-     *
620
-     * @deprecated since 4.9.1
621
-     */
622
-    protected function _register_rpc_routes()
623
-    {
624
-        $routes = array();
625
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
626
-            $routes[ self::ee_api_namespace . $version ] = $this->_get_rpc_route_data_for_version(
627
-                $version,
628
-                $hidden_endpoint
629
-            );
630
-        }
631
-        return $routes;
632
-    }
633
-
634
-
635
-    /**
636
-     * @param string  $version
637
-     * @param boolean $hidden_endpoint
638
-     * @return array
639
-     */
640
-    protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false)
641
-    {
642
-        $this_versions_routes = array();
643
-        // checkin endpoint
644
-        $this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = array(
645
-            array(
646
-                'callback'        => array(
647
-                    'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
648
-                    'handleRequestToggleCheckin',
649
-                ),
650
-                'methods'         => WP_REST_Server::CREATABLE,
651
-                'hidden_endpoint' => $hidden_endpoint,
652
-                'args'            => array(
653
-                    'force' => array(
654
-                        'required'    => false,
655
-                        'default'     => false,
656
-                        'description' => __(
657
-                        // @codingStandardsIgnoreStart
658
-                            'Whether to force toggle checkin, or to verify the registration status and allowed ticket uses',
659
-                            // @codingStandardsIgnoreEnd
660
-                            'event_espresso'
661
-                        ),
662
-                    ),
663
-                ),
664
-                'callback_args'   => array($version),
665
-            ),
666
-        );
667
-        return apply_filters(
668
-            'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
669
-            $this_versions_routes,
670
-            $version,
671
-            $hidden_endpoint
672
-        );
673
-    }
674
-
675
-
676
-    /**
677
-     * Gets the query params that can be used when request one or many
678
-     *
679
-     * @param EEM_Base $model
680
-     * @param string   $version
681
-     * @return array
682
-     */
683
-    protected function _get_response_selection_query_params(\EEM_Base $model, $version)
684
-    {
685
-        return apply_filters(
686
-            'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
687
-            array(
688
-                'include'   => array(
689
-                    'required' => false,
690
-                    'default'  => '*',
691
-                    'type'     => 'string',
692
-                ),
693
-                'calculate' => array(
694
-                    'required'          => false,
695
-                    'default'           => '',
696
-                    'enum'              => self::$_field_calculator->retrieveCalculatedFieldsForModel($model),
697
-                    'type'              => 'string',
698
-                    // because we accept a CSV'd list of the enumerated strings, WP core validation and sanitization
699
-                    // freaks out. We'll just validate this argument while handling the request
700
-                    'validate_callback' => null,
701
-                    'sanitize_callback' => null,
702
-                ),
703
-            ),
704
-            $model,
705
-            $version
706
-        );
707
-    }
708
-
709
-
710
-    /**
711
-     * Gets the parameters acceptable for delete requests
712
-     *
713
-     * @param \EEM_Base $model
714
-     * @param string    $version
715
-     * @return array
716
-     */
717
-    protected function _get_delete_query_params(\EEM_Base $model, $version)
718
-    {
719
-        $params_for_delete = array(
720
-            'allow_blocking' => array(
721
-                'required' => false,
722
-                'default'  => true,
723
-                'type'     => 'boolean',
724
-            ),
725
-        );
726
-        $params_for_delete['force'] = array(
727
-            'required' => false,
728
-            'default'  => false,
729
-            'type'     => 'boolean',
730
-        );
731
-        return apply_filters(
732
-            'FHEE__EED_Core_Rest_Api___get_delete_query_params',
733
-            $params_for_delete,
734
-            $model,
735
-            $version
736
-        );
737
-    }
738
-
739
-
740
-    /**
741
-     * Gets info about reading query params that are acceptable
742
-     *
743
-     * @param \EEM_Base $model eg 'Event' or 'Venue'
744
-     * @param  string   $version
745
-     * @return array    describing the args acceptable when querying this model
746
-     * @throws EE_Error
747
-     */
748
-    protected function _get_read_query_params(\EEM_Base $model, $version)
749
-    {
750
-        $default_orderby = array();
751
-        foreach ($model->get_combined_primary_key_fields() as $key_field) {
752
-            $default_orderby[ $key_field->get_name() ] = 'ASC';
753
-        }
754
-        return array_merge(
755
-            $this->_get_response_selection_query_params($model, $version),
756
-            array(
757
-                'where'    => array(
758
-                    'required'          => false,
759
-                    'default'           => array(),
760
-                    'type'              => 'object',
761
-                    // because we accept an almost infinite list of possible where conditions, WP
762
-                    // core validation and sanitization freaks out. We'll just validate this argument
763
-                    // while handling the request
764
-                    'validate_callback' => null,
765
-                    'sanitize_callback' => null,
766
-                ),
767
-                'limit'    => array(
768
-                    'required'          => false,
769
-                    'default'           => EED_Core_Rest_Api::get_default_query_limit(),
770
-                    'type'              => array(
771
-                        'array',
772
-                        'string',
773
-                        'integer',
774
-                    ),
775
-                    // because we accept a variety of types, WP core validation and sanitization
776
-                    // freaks out. We'll just validate this argument while handling the request
777
-                    'validate_callback' => null,
778
-                    'sanitize_callback' => null,
779
-                ),
780
-                'order_by' => array(
781
-                    'required'          => false,
782
-                    'default'           => $default_orderby,
783
-                    'type'              => array(
784
-                        'object',
785
-                        'string',
786
-                    ),// because we accept a variety of types, WP core validation and sanitization
787
-                    // freaks out. We'll just validate this argument while handling the request
788
-                    'validate_callback' => null,
789
-                    'sanitize_callback' => null,
790
-                ),
791
-                'group_by' => array(
792
-                    'required'          => false,
793
-                    'default'           => null,
794
-                    'type'              => array(
795
-                        'object',
796
-                        'string',
797
-                    ),
798
-                    // because we accept  an almost infinite list of possible groupings,
799
-                    // WP core validation and sanitization
800
-                    // freaks out. We'll just validate this argument while handling the request
801
-                    'validate_callback' => null,
802
-                    'sanitize_callback' => null,
803
-                ),
804
-                'having'   => array(
805
-                    'required'          => false,
806
-                    'default'           => null,
807
-                    'type'              => 'object',
808
-                    // because we accept an almost infinite list of possible where conditions, WP
809
-                    // core validation and sanitization freaks out. We'll just validate this argument
810
-                    // while handling the request
811
-                    'validate_callback' => null,
812
-                    'sanitize_callback' => null,
813
-                ),
814
-                'caps'     => array(
815
-                    'required' => false,
816
-                    'default'  => EEM_Base::caps_read,
817
-                    'type'     => 'string',
818
-                    'enum'     => array(
819
-                        EEM_Base::caps_read,
820
-                        EEM_Base::caps_read_admin,
821
-                        EEM_Base::caps_edit,
822
-                        EEM_Base::caps_delete,
823
-                    ),
824
-                ),
825
-            )
826
-        );
827
-    }
828
-
829
-
830
-    /**
831
-     * Gets parameter information for a model regarding writing data
832
-     *
833
-     * @param string           $model_name
834
-     * @param ModelVersionInfo $model_version_info
835
-     * @param boolean          $create                                       whether this is for request to create (in
836
-     *                                                                       which case we need all required params) or
837
-     *                                                                       just to update (in which case we don't
838
-     *                                                                       need those on every request)
839
-     * @return array
840
-     */
841
-    protected function _get_write_params(
842
-        $model_name,
843
-        ModelVersionInfo $model_version_info,
844
-        $create = false
845
-    ) {
846
-        $model = EE_Registry::instance()->load_model($model_name);
847
-        $fields = $model_version_info->fieldsOnModelInThisVersion($model);
848
-        $args_info = array();
849
-        foreach ($fields as $field_name => $field_obj) {
850
-            if ($field_obj->is_auto_increment()) {
851
-                // totally ignore auto increment IDs
852
-                continue;
853
-            }
854
-            $arg_info = $field_obj->getSchema();
855
-            $required = $create && ! $field_obj->is_nullable() && $field_obj->get_default_value() === null;
856
-            $arg_info['required'] = $required;
857
-            // remove the read-only flag. If it were read-only we wouldn't list it as an argument while writing, right?
858
-            unset($arg_info['readonly']);
859
-            $schema_properties = $field_obj->getSchemaProperties();
860
-            if (isset($schema_properties['raw'])
861
-                && $field_obj->getSchemaType() === 'object'
862
-            ) {
863
-                // if there's a "raw" form of this argument, use those properties instead
864
-                $arg_info = array_replace(
865
-                    $arg_info,
866
-                    $schema_properties['raw']
867
-                );
868
-            }
869
-            $arg_info['default'] = ModelDataTranslator::prepareFieldValueForJson(
870
-                $field_obj,
871
-                $field_obj->get_default_value(),
872
-                $model_version_info->requestedVersion()
873
-            );
874
-            // we do our own validation and sanitization within the controller
875
-            if (function_exists('rest_validate_value_from_schema')) {
876
-                $sanitize_callback = array(
877
-                    'EED_Core_Rest_Api',
878
-                    'default_sanitize_callback',
879
-                );
880
-            } else {
881
-                $sanitize_callback = null;
882
-            }
883
-            $arg_info['sanitize_callback'] = $sanitize_callback;
884
-            $args_info[ $field_name ] = $arg_info;
885
-            if ($field_obj instanceof EE_Datetime_Field) {
886
-                $gmt_arg_info = $arg_info;
887
-                $gmt_arg_info['description'] = sprintf(
888
-                    esc_html__(
889
-                        '%1$s - the value for this field in UTC. Ignored if %2$s is provided.',
890
-                        'event_espresso'
891
-                    ),
892
-                    $field_obj->get_nicename(),
893
-                    $field_name
894
-                );
895
-                $args_info[ $field_name . '_gmt' ] = $gmt_arg_info;
896
-            }
897
-        }
898
-        return $args_info;
899
-    }
900
-
901
-
902
-    /**
903
-     * Replacement for WP API's 'rest_parse_request_arg'.
904
-     * If the value is blank but not required, don't bother validating it.
905
-     * Also, it uses our email validation instead of WP API's default.
906
-     *
907
-     * @param                 $value
908
-     * @param WP_REST_Request $request
909
-     * @param                 $param
910
-     * @return bool|true|WP_Error
911
-     * @throws InvalidArgumentException
912
-     * @throws InvalidInterfaceException
913
-     * @throws InvalidDataTypeException
914
-     */
915
-    public static function default_sanitize_callback($value, WP_REST_Request $request, $param)
916
-    {
917
-        $attributes = $request->get_attributes();
918
-        if (! isset($attributes['args'][ $param ])
919
-            || ! is_array($attributes['args'][ $param ])) {
920
-            $validation_result = true;
921
-        } else {
922
-            $args = $attributes['args'][ $param ];
923
-            if ((
924
-                    $value === ''
925
-                    || $value === null
926
-                )
927
-                && (! isset($args['required'])
928
-                    || $args['required'] === false
929
-                )
930
-            ) {
931
-                // not required and not provided? that's cool
932
-                $validation_result = true;
933
-            } elseif (isset($args['format'])
934
-                      && $args['format'] === 'email'
935
-            ) {
936
-                $validation_result = true;
937
-                if (! self::_validate_email($value)) {
938
-                    $validation_result = new WP_Error(
939
-                        'rest_invalid_param',
940
-                        esc_html__(
941
-                            'The email address is not valid or does not exist.',
942
-                            'event_espresso'
943
-                        )
944
-                    );
945
-                }
946
-            } else {
947
-                $validation_result = rest_validate_value_from_schema($value, $args, $param);
948
-            }
949
-        }
950
-        if (is_wp_error($validation_result)) {
951
-            return $validation_result;
952
-        }
953
-        return rest_sanitize_request_arg($value, $request, $param);
954
-    }
955
-
956
-
957
-    /**
958
-     * Returns whether or not this email address is valid. Copied from EE_Email_Validation_Strategy::_validate_email()
959
-     *
960
-     * @param $email
961
-     * @return bool
962
-     * @throws InvalidArgumentException
963
-     * @throws InvalidInterfaceException
964
-     * @throws InvalidDataTypeException
965
-     */
966
-    protected static function _validate_email($email)
967
-    {
968
-        try {
969
-            EmailAddressFactory::create($email);
970
-            return true;
971
-        } catch (EmailValidationException $e) {
972
-            return false;
973
-        }
974
-    }
975
-
976
-
977
-    /**
978
-     * Gets routes for the config
979
-     *
980
-     * @return array @see _register_model_routes
981
-     * @deprecated since version 4.9.1
982
-     */
983
-    protected function _register_config_routes()
984
-    {
985
-        $config_routes = array();
986
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
987
-            $config_routes[ self::ee_api_namespace . $version ] = $this->_get_config_route_data_for_version(
988
-                $version,
989
-                $hidden_endpoint
990
-            );
991
-        }
992
-        return $config_routes;
993
-    }
994
-
995
-
996
-    /**
997
-     * Gets routes for the config for the specified version
998
-     *
999
-     * @param string  $version
1000
-     * @param boolean $hidden_endpoint
1001
-     * @return array
1002
-     */
1003
-    protected function _get_config_route_data_for_version($version, $hidden_endpoint)
1004
-    {
1005
-        return array(
1006
-            'config'    => array(
1007
-                array(
1008
-                    'callback'        => array(
1009
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
1010
-                        'handleRequest',
1011
-                    ),
1012
-                    'methods'         => WP_REST_Server::READABLE,
1013
-                    'hidden_endpoint' => $hidden_endpoint,
1014
-                    'callback_args'   => array($version),
1015
-                ),
1016
-            ),
1017
-            'site_info' => array(
1018
-                array(
1019
-                    'callback'        => array(
1020
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
1021
-                        'handleRequestSiteInfo',
1022
-                    ),
1023
-                    'methods'         => WP_REST_Server::READABLE,
1024
-                    'hidden_endpoint' => $hidden_endpoint,
1025
-                    'callback_args'   => array($version),
1026
-                ),
1027
-            ),
1028
-        );
1029
-    }
1030
-
1031
-
1032
-    /**
1033
-     * Gets the meta info routes
1034
-     *
1035
-     * @return array @see _register_model_routes
1036
-     * @deprecated since version 4.9.1
1037
-     */
1038
-    protected function _register_meta_routes()
1039
-    {
1040
-        $meta_routes = array();
1041
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
1042
-            $meta_routes[ self::ee_api_namespace . $version ] = $this->_get_meta_route_data_for_version(
1043
-                $version,
1044
-                $hidden_endpoint
1045
-            );
1046
-        }
1047
-        return $meta_routes;
1048
-    }
1049
-
1050
-
1051
-    /**
1052
-     * @param string  $version
1053
-     * @param boolean $hidden_endpoint
1054
-     * @return array
1055
-     */
1056
-    protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false)
1057
-    {
1058
-        return array(
1059
-            'resources' => array(
1060
-                array(
1061
-                    'callback'        => array(
1062
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
1063
-                        'handleRequestModelsMeta',
1064
-                    ),
1065
-                    'methods'         => WP_REST_Server::READABLE,
1066
-                    'hidden_endpoint' => $hidden_endpoint,
1067
-                    'callback_args'   => array($version),
1068
-                ),
1069
-            ),
1070
-        );
1071
-    }
1072
-
1073
-
1074
-    /**
1075
-     * Tries to hide old 4.6 endpoints from the
1076
-     *
1077
-     * @param array $route_data
1078
-     * @return array
1079
-     * @throws \EE_Error
1080
-     */
1081
-    public static function hide_old_endpoints($route_data)
1082
-    {
1083
-        // allow API clients to override which endpoints get hidden, in case
1084
-        // they want to discover particular endpoints
1085
-        // also, we don't have access to the request so we have to just grab it from the superglobal
1086
-        $force_show_ee_namespace = ltrim(
1087
-            EEH_Array::is_set($_REQUEST, 'force_show_ee_namespace', ''),
1088
-            '/'
1089
-        );
1090
-        foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
1091
-            foreach ($relative_urls as $resource_name => $endpoints) {
1092
-                foreach ($endpoints as $key => $endpoint) {
1093
-                    // skip schema and other route options
1094
-                    if (! is_numeric($key)) {
1095
-                        continue;
1096
-                    }
1097
-                    // by default, hide "hidden_endpoint"s, unless the request indicates
1098
-                    // to $force_show_ee_namespace, in which case only show that one
1099
-                    // namespace's endpoints (and hide all others)
1100
-                    if (($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
1101
-                        || ($endpoint['hidden_endpoint'] && $force_show_ee_namespace === '')
1102
-                    ) {
1103
-                        $full_route = '/' . ltrim($namespace, '/');
1104
-                        $full_route .= '/' . ltrim($resource_name, '/');
1105
-                        unset($route_data[ $full_route ]);
1106
-                    }
1107
-                }
1108
-            }
1109
-        }
1110
-        return $route_data;
1111
-    }
1112
-
1113
-
1114
-    /**
1115
-     * Returns an array describing which versions of core support serving requests for.
1116
-     * Keys are core versions' major and minor version, and values are the
1117
-     * LOWEST requested version they can serve. Eg, 4.7 can serve requests for 4.6-like
1118
-     * data by just removing a few models and fields from the responses. However, 4.15 might remove
1119
-     * the answers table entirely, in which case it would be very difficult for
1120
-     * it to serve 4.6-style responses.
1121
-     * Versions of core that are missing from this array are unknowns.
1122
-     * previous ver
1123
-     *
1124
-     * @return array
1125
-     */
1126
-    public static function version_compatibilities()
1127
-    {
1128
-        return apply_filters(
1129
-            'FHEE__EED_Core_REST_API__version_compatibilities',
1130
-            array(
1131
-                '4.8.29' => '4.8.29',
1132
-                '4.8.33' => '4.8.29',
1133
-                '4.8.34' => '4.8.29',
1134
-                '4.8.36' => '4.8.29',
1135
-            )
1136
-        );
1137
-    }
1138
-
1139
-
1140
-    /**
1141
-     * Gets the latest API version served. Eg if there
1142
-     * are two versions served of the API, 4.8.29 and 4.8.32, and
1143
-     * we are on core version 4.8.34, it will return the string "4.8.32"
1144
-     *
1145
-     * @return string
1146
-     */
1147
-    public static function latest_rest_api_version()
1148
-    {
1149
-        $versions_served = \EED_Core_Rest_Api::versions_served();
1150
-        $versions_served_keys = array_keys($versions_served);
1151
-        return end($versions_served_keys);
1152
-    }
1153
-
1154
-
1155
-    /**
1156
-     * Using EED_Core_Rest_Api::version_compatibilities(), determines what version of
1157
-     * EE the API can serve requests for. Eg, if we are on 4.15 of core, and
1158
-     * we can serve requests from 4.12 or later, this will return array( '4.12', '4.13', '4.14', '4.15' ).
1159
-     * We also indicate whether or not this version should be put in the index or not
1160
-     *
1161
-     * @return array keys are API version numbers (just major and minor numbers), and values
1162
-     * are whether or not they should be hidden
1163
-     */
1164
-    public static function versions_served()
1165
-    {
1166
-        $versions_served = array();
1167
-        $possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
1168
-        $lowest_compatible_version = end($possibly_served_versions);
1169
-        reset($possibly_served_versions);
1170
-        $versions_served_historically = array_keys($possibly_served_versions);
1171
-        $latest_version = end($versions_served_historically);
1172
-        reset($versions_served_historically);
1173
-        // for each version of core we have ever served:
1174
-        foreach ($versions_served_historically as $key_versioned_endpoint) {
1175
-            // if it's not above the current core version, and it's compatible with the current version of core
1176
-            if ($key_versioned_endpoint === $latest_version) {
1177
-                // don't hide the latest version in the index
1178
-                $versions_served[ $key_versioned_endpoint ] = false;
1179
-            } elseif ($key_versioned_endpoint >= $lowest_compatible_version
1180
-                && $key_versioned_endpoint < EED_Core_Rest_Api::core_version()
1181
-            ) {
1182
-                // include, but hide, previous versions which are still supported
1183
-                $versions_served[ $key_versioned_endpoint ] = true;
1184
-            } elseif (apply_filters(
1185
-                'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
1186
-                false,
1187
-                $possibly_served_versions
1188
-            )) {
1189
-                // if a version is no longer supported, don't include it in index or list of versions served
1190
-                $versions_served[ $key_versioned_endpoint ] = true;
1191
-            }
1192
-        }
1193
-        return $versions_served;
1194
-    }
1195
-
1196
-
1197
-    /**
1198
-     * Gets the major and minor version of EE core's version string
1199
-     *
1200
-     * @return string
1201
-     */
1202
-    public static function core_version()
1203
-    {
1204
-        return apply_filters(
1205
-            'FHEE__EED_Core_REST_API__core_version',
1206
-            implode(
1207
-                '.',
1208
-                array_slice(
1209
-                    explode(
1210
-                        '.',
1211
-                        espresso_version()
1212
-                    ),
1213
-                    0,
1214
-                    3
1215
-                )
1216
-            )
1217
-        );
1218
-    }
1219
-
1220
-
1221
-    /**
1222
-     * Gets the default limit that should be used when querying for resources
1223
-     *
1224
-     * @return int
1225
-     */
1226
-    public static function get_default_query_limit()
1227
-    {
1228
-        // we actually don't use a const because we want folks to always use
1229
-        // this method, not the const directly
1230
-        return apply_filters(
1231
-            'FHEE__EED_Core_Rest_Api__get_default_query_limit',
1232
-            50
1233
-        );
1234
-    }
1235
-
1236
-
1237
-    /**
1238
-     *
1239
-     * @param string $version api version string (i.e. '4.8.36')
1240
-     * @return array
1241
-     */
1242
-    public static function getCollectionRoutesIndexedByModelName($version = '')
1243
-    {
1244
-        $version = empty($version) ? self::latest_rest_api_version() : $version;
1245
-        $model_names = self::model_names_with_plural_routes($version);
1246
-        $collection_routes = array();
1247
-        foreach ($model_names as $model_name => $model_class_name) {
1248
-            $collection_routes[ strtolower($model_name) ] = '/' . self::ee_api_namespace . $version . '/'
1249
-                                                            . EEH_Inflector::pluralize_and_lower($model_name);
1250
-        }
1251
-        return $collection_routes;
1252
-    }
1253
-
1254
-
1255
-    /**
1256
-     * Returns an array of primary key names indexed by model names.
1257
-     * @param string $version
1258
-     * @return array
1259
-     */
1260
-    public static function getPrimaryKeyNamesIndexedByModelName($version = '')
1261
-    {
1262
-        $version = empty($version) ? self::latest_rest_api_version() : $version;
1263
-        $model_names = self::model_names_with_plural_routes($version);
1264
-        $primary_key_items = array();
1265
-        foreach ($model_names as $model_name => $model_class_name) {
1266
-            $primary_keys = $model_class_name::instance()->get_combined_primary_key_fields();
1267
-            foreach ($primary_keys as $primary_key_name => $primary_key_field) {
1268
-                if (count($primary_keys) > 1) {
1269
-                    $primary_key_items[ strtolower($model_name) ][] = $primary_key_name;
1270
-                } else {
1271
-                    $primary_key_items[ strtolower($model_name) ] = $primary_key_name;
1272
-                }
1273
-            }
1274
-        }
1275
-        return $primary_key_items;
1276
-    }
1277
-
1278
-
1279
-
1280
-    /**
1281
-     *    run - initial module setup
1282
-     *
1283
-     * @access    public
1284
-     * @param  WP $WP
1285
-     * @return    void
1286
-     */
1287
-    public function run($WP)
1288
-    {
1289
-    }
26
+	const ee_api_namespace = Domain::API_NAMESPACE;
27
+
28
+	const ee_api_namespace_for_regex = 'ee\/v([^/]*)\/';
29
+
30
+	const saved_routes_option_names = 'ee_core_routes';
31
+
32
+	/**
33
+	 * string used in _links response bodies to make them globally unique.
34
+	 *
35
+	 * @see http://v2.wp-api.org/extending/linking/
36
+	 */
37
+	const ee_api_link_namespace = 'https://api.eventespresso.com/';
38
+
39
+	/**
40
+	 * @var CalculatedModelFields
41
+	 */
42
+	protected static $_field_calculator;
43
+
44
+
45
+	/**
46
+	 * @return EED_Core_Rest_Api|EED_Module
47
+	 */
48
+	public static function instance()
49
+	{
50
+		self::$_field_calculator = LoaderFactory::getLoader()->load('EventEspresso\core\libraries\rest_api\CalculatedModelFields');
51
+		return parent::get_instance(__CLASS__);
52
+	}
53
+
54
+
55
+	/**
56
+	 *    set_hooks - for hooking into EE Core, other modules, etc
57
+	 *
58
+	 * @access    public
59
+	 * @return    void
60
+	 */
61
+	public static function set_hooks()
62
+	{
63
+		self::set_hooks_both();
64
+	}
65
+
66
+
67
+	/**
68
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
69
+	 *
70
+	 * @access    public
71
+	 * @return    void
72
+	 */
73
+	public static function set_hooks_admin()
74
+	{
75
+		self::set_hooks_both();
76
+	}
77
+
78
+
79
+	public static function set_hooks_both()
80
+	{
81
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'register_routes'), 10);
82
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'set_hooks_rest_api'), 5);
83
+		add_filter('rest_route_data', array('EED_Core_Rest_Api', 'hide_old_endpoints'), 10, 2);
84
+		add_filter(
85
+			'rest_index',
86
+			array('EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filterEeMetadataIntoIndex')
87
+		);
88
+		EED_Core_Rest_Api::invalidate_cached_route_data_on_version_change();
89
+	}
90
+
91
+
92
+	/**
93
+	 * sets up hooks which only need to be included as part of REST API requests;
94
+	 * other requests like to the frontend or admin etc don't need them
95
+	 *
96
+	 * @throws \EE_Error
97
+	 */
98
+	public static function set_hooks_rest_api()
99
+	{
100
+		// set hooks which account for changes made to the API
101
+		EED_Core_Rest_Api::_set_hooks_for_changes();
102
+	}
103
+
104
+
105
+	/**
106
+	 * public wrapper of _set_hooks_for_changes.
107
+	 * Loads all the hooks which make requests to old versions of the API
108
+	 * appear the same as they always did
109
+	 *
110
+	 * @throws EE_Error
111
+	 */
112
+	public static function set_hooks_for_changes()
113
+	{
114
+		self::_set_hooks_for_changes();
115
+	}
116
+
117
+
118
+	/**
119
+	 * Loads all the hooks which make requests to old versions of the API
120
+	 * appear the same as they always did
121
+	 *
122
+	 * @throws EE_Error
123
+	 */
124
+	protected static function _set_hooks_for_changes()
125
+	{
126
+		$folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
127
+		foreach ($folder_contents as $classname_in_namespace => $filepath) {
128
+			// ignore the base parent class
129
+			// and legacy named classes
130
+			if ($classname_in_namespace === 'ChangesInBase'
131
+				|| strpos($classname_in_namespace, 'Changes_In_') === 0
132
+			) {
133
+				continue;
134
+			}
135
+			$full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
136
+			if (class_exists($full_classname)) {
137
+				$instance_of_class = new $full_classname;
138
+				if ($instance_of_class instanceof ChangesInBase) {
139
+					$instance_of_class->setHooks();
140
+				}
141
+			}
142
+		}
143
+	}
144
+
145
+
146
+	/**
147
+	 * Filters the WP routes to add our EE-related ones. This takes a bit of time
148
+	 * so we actually prefer to only do it when an EE plugin is activated or upgraded
149
+	 *
150
+	 * @throws \EE_Error
151
+	 */
152
+	public static function register_routes()
153
+	{
154
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_routes) {
155
+			foreach ($relative_routes as $relative_route => $data_for_multiple_endpoints) {
156
+				/**
157
+				 * @var array     $data_for_multiple_endpoints numerically indexed array
158
+				 *                                         but can also contain route options like {
159
+				 * @type array    $schema                      {
160
+				 * @type callable $schema_callback
161
+				 * @type array    $callback_args               arguments that will be passed to the callback, after the
162
+				 * WP_REST_Request of course
163
+				 * }
164
+				 * }
165
+				 */
166
+				// when registering routes, register all the endpoints' data at the same time
167
+				$multiple_endpoint_args = array();
168
+				foreach ($data_for_multiple_endpoints as $endpoint_key => $data_for_single_endpoint) {
169
+					/**
170
+					 * @var array     $data_for_single_endpoint {
171
+					 * @type callable $callback
172
+					 * @type string methods
173
+					 * @type array args
174
+					 * @type array _links
175
+					 * @type array    $callback_args            arguments that will be passed to the callback, after the
176
+					 * WP_REST_Request of course
177
+					 * }
178
+					 */
179
+					// skip route options
180
+					if (! is_numeric($endpoint_key)) {
181
+						continue;
182
+					}
183
+					if (! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) {
184
+						throw new EE_Error(
185
+							esc_html__(
186
+							// @codingStandardsIgnoreStart
187
+								'Endpoint configuration data needs to have entries "callback" (callable) and "methods" (comma-separated list of accepts HTTP methods).',
188
+								// @codingStandardsIgnoreEnd
189
+								'event_espresso'
190
+							)
191
+						);
192
+					}
193
+					$callback = $data_for_single_endpoint['callback'];
194
+					$single_endpoint_args = array(
195
+						'methods' => $data_for_single_endpoint['methods'],
196
+						'args'    => isset($data_for_single_endpoint['args']) ? $data_for_single_endpoint['args']
197
+							: array(),
198
+					);
199
+					if (isset($data_for_single_endpoint['_links'])) {
200
+						$single_endpoint_args['_links'] = $data_for_single_endpoint['_links'];
201
+					}
202
+					if (isset($data_for_single_endpoint['callback_args'])) {
203
+						$callback_args = $data_for_single_endpoint['callback_args'];
204
+						$single_endpoint_args['callback'] = function (\WP_REST_Request $request) use (
205
+							$callback,
206
+							$callback_args
207
+						) {
208
+							array_unshift($callback_args, $request);
209
+							return call_user_func_array(
210
+								$callback,
211
+								$callback_args
212
+							);
213
+						};
214
+					} else {
215
+						$single_endpoint_args['callback'] = $data_for_single_endpoint['callback'];
216
+					}
217
+					$multiple_endpoint_args[] = $single_endpoint_args;
218
+				}
219
+				if (isset($data_for_multiple_endpoints['schema'])) {
220
+					$schema_route_data = $data_for_multiple_endpoints['schema'];
221
+					$schema_callback = $schema_route_data['schema_callback'];
222
+					$callback_args = $schema_route_data['callback_args'];
223
+					$multiple_endpoint_args['schema'] = function () use ($schema_callback, $callback_args) {
224
+						return call_user_func_array(
225
+							$schema_callback,
226
+							$callback_args
227
+						);
228
+					};
229
+				}
230
+				register_rest_route(
231
+					$namespace,
232
+					$relative_route,
233
+					$multiple_endpoint_args
234
+				);
235
+			}
236
+		}
237
+	}
238
+
239
+
240
+	/**
241
+	 * Checks if there was a version change or something that merits invalidating the cached
242
+	 * route data. If so, invalidates the cached route data so that it gets refreshed
243
+	 * next time the WP API is used
244
+	 */
245
+	public static function invalidate_cached_route_data_on_version_change()
246
+	{
247
+		if (EE_System::instance()->detect_req_type() !== EE_System::req_type_normal) {
248
+			EED_Core_Rest_Api::invalidate_cached_route_data();
249
+		}
250
+		foreach (EE_Registry::instance()->addons as $addon) {
251
+			if ($addon instanceof EE_Addon && $addon->detect_req_type() !== EE_System::req_type_normal) {
252
+				EED_Core_Rest_Api::invalidate_cached_route_data();
253
+			}
254
+		}
255
+	}
256
+
257
+
258
+	/**
259
+	 * Removes the cached route data so it will get refreshed next time the WP API is used
260
+	 */
261
+	public static function invalidate_cached_route_data()
262
+	{
263
+		// delete the saved EE REST API routes
264
+		foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
265
+			delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
266
+		}
267
+	}
268
+
269
+
270
+	/**
271
+	 * Gets the EE route data
272
+	 *
273
+	 * @return array top-level key is the namespace, next-level key is the route and its value is array{
274
+	 * @throws \EE_Error
275
+	 * @type string|array $callback
276
+	 * @type string       $methods
277
+	 * @type boolean      $hidden_endpoint
278
+	 * }
279
+	 */
280
+	public static function get_ee_route_data()
281
+	{
282
+		$ee_routes = array();
283
+		foreach (self::versions_served() as $version => $hidden_endpoints) {
284
+			$ee_routes[ self::ee_api_namespace . $version ] = self::_get_ee_route_data_for_version(
285
+				$version,
286
+				$hidden_endpoints
287
+			);
288
+		}
289
+		return $ee_routes;
290
+	}
291
+
292
+
293
+	/**
294
+	 * Gets the EE route data from the wp options if it exists already,
295
+	 * otherwise re-generates it and saves it to the option
296
+	 *
297
+	 * @param string  $version
298
+	 * @param boolean $hidden_endpoints
299
+	 * @return array
300
+	 * @throws \EE_Error
301
+	 */
302
+	protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
303
+	{
304
+		$ee_routes = get_option(self::saved_routes_option_names . $version, null);
305
+		if (! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
306
+			$ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
307
+		}
308
+		return $ee_routes;
309
+	}
310
+
311
+
312
+	/**
313
+	 * Saves the EE REST API route data to a wp option and returns it
314
+	 *
315
+	 * @param string  $version
316
+	 * @param boolean $hidden_endpoints
317
+	 * @return mixed|null
318
+	 * @throws \EE_Error
319
+	 */
320
+	protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
321
+	{
322
+		$instance = self::instance();
323
+		$routes = apply_filters(
324
+			'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
325
+			array_replace_recursive(
326
+				$instance->_get_config_route_data_for_version($version, $hidden_endpoints),
327
+				$instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
328
+				$instance->_get_model_route_data_for_version($version, $hidden_endpoints),
329
+				$instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
330
+			)
331
+		);
332
+		$option_name = self::saved_routes_option_names . $version;
333
+		if (get_option($option_name)) {
334
+			update_option($option_name, $routes, true);
335
+		} else {
336
+			add_option($option_name, $routes, null, 'no');
337
+		}
338
+		return $routes;
339
+	}
340
+
341
+
342
+	/**
343
+	 * Calculates all the EE routes and saves it to a WordPress option so we don't
344
+	 * need to calculate it on every request
345
+	 *
346
+	 * @deprecated since version 4.9.1
347
+	 * @return void
348
+	 */
349
+	public static function save_ee_routes()
350
+	{
351
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
352
+			$instance = self::instance();
353
+			$routes = apply_filters(
354
+				'EED_Core_Rest_Api__save_ee_routes__routes',
355
+				array_replace_recursive(
356
+					$instance->_register_config_routes(),
357
+					$instance->_register_meta_routes(),
358
+					$instance->_register_model_routes(),
359
+					$instance->_register_rpc_routes()
360
+				)
361
+			);
362
+			update_option(self::saved_routes_option_names, $routes, true);
363
+		}
364
+	}
365
+
366
+
367
+	/**
368
+	 * Gets all the route information relating to EE models
369
+	 *
370
+	 * @return array @see get_ee_route_data
371
+	 * @deprecated since version 4.9.1
372
+	 */
373
+	protected function _register_model_routes()
374
+	{
375
+		$model_routes = array();
376
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
377
+			$model_routes[ EED_Core_Rest_Api::ee_api_namespace
378
+						   . $version ] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
379
+		}
380
+		return $model_routes;
381
+	}
382
+
383
+
384
+	/**
385
+	 * Decides whether or not to add write endpoints for this model.
386
+	 *
387
+	 * Currently, this defaults to exclude all global tables and models
388
+	 * which would allow inserting WP core data (we don't want to duplicate
389
+	 * what WP API does, as it's unnecessary, extra work, and potentially extra bugs)
390
+	 *
391
+	 * @param EEM_Base $model
392
+	 * @return bool
393
+	 */
394
+	public static function should_have_write_endpoints(EEM_Base $model)
395
+	{
396
+		if ($model->is_wp_core_model()) {
397
+			return false;
398
+		}
399
+		foreach ($model->get_tables() as $table) {
400
+			if ($table->is_global()) {
401
+				return false;
402
+			}
403
+		}
404
+		return true;
405
+	}
406
+
407
+
408
+	/**
409
+	 * Gets the names of all models which should have plural routes (eg `ee/v4.8.36/events`)
410
+	 * in this versioned namespace of EE4
411
+	 *
412
+	 * @param $version
413
+	 * @return array keys are model names (eg 'Event') and values ar either classnames (eg 'EEM_Event')
414
+	 */
415
+	public static function model_names_with_plural_routes($version)
416
+	{
417
+		$model_version_info = new ModelVersionInfo($version);
418
+		$models_to_register = $model_version_info->modelsForRequestedVersion();
419
+		// let's not bother having endpoints for extra metas
420
+		unset(
421
+			$models_to_register['Extra_Meta'],
422
+			$models_to_register['Extra_Join'],
423
+			$models_to_register['Post_Meta']
424
+		);
425
+		return apply_filters(
426
+			'FHEE__EED_Core_REST_API___register_model_routes',
427
+			$models_to_register
428
+		);
429
+	}
430
+
431
+
432
+	/**
433
+	 * Gets the route data for EE models in the specified version
434
+	 *
435
+	 * @param string  $version
436
+	 * @param boolean $hidden_endpoint
437
+	 * @return array
438
+	 * @throws EE_Error
439
+	 */
440
+	protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
441
+	{
442
+		$model_routes = array();
443
+		$model_version_info = new ModelVersionInfo($version);
444
+		foreach (EED_Core_Rest_Api::model_names_with_plural_routes($version) as $model_name => $model_classname) {
445
+			$model = \EE_Registry::instance()->load_model($model_name);
446
+			// if this isn't a valid model then let's skip iterate to the next item in the loop.
447
+			if (! $model instanceof EEM_Base) {
448
+				continue;
449
+			}
450
+			// yes we could just register one route for ALL models, but then they wouldn't show up in the index
451
+			$plural_model_route = EED_Core_Rest_Api::get_collection_route($model);
452
+			$singular_model_route = EED_Core_Rest_Api::get_entity_route($model, '(?P<id>[^\/]+)');
453
+			$model_routes[ $plural_model_route ] = array(
454
+				array(
455
+					'callback'        => array(
456
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
457
+						'handleRequestGetAll',
458
+					),
459
+					'callback_args'   => array($version, $model_name),
460
+					'methods'         => WP_REST_Server::READABLE,
461
+					'hidden_endpoint' => $hidden_endpoint,
462
+					'args'            => $this->_get_read_query_params($model, $version),
463
+					'_links'          => array(
464
+						'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
465
+					),
466
+				),
467
+				'schema' => array(
468
+					'schema_callback' => array(
469
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
470
+						'handleSchemaRequest',
471
+					),
472
+					'callback_args'   => array($version, $model_name),
473
+				),
474
+			);
475
+			$model_routes[ $singular_model_route ] = array(
476
+				array(
477
+					'callback'        => array(
478
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
479
+						'handleRequestGetOne',
480
+					),
481
+					'callback_args'   => array($version, $model_name),
482
+					'methods'         => WP_REST_Server::READABLE,
483
+					'hidden_endpoint' => $hidden_endpoint,
484
+					'args'            => $this->_get_response_selection_query_params($model, $version),
485
+				),
486
+			);
487
+			if (apply_filters(
488
+				'FHEE__EED_Core_Rest_Api___get_model_route_data_for_version__add_write_endpoints',
489
+				EED_Core_Rest_Api::should_have_write_endpoints($model),
490
+				$model
491
+			)) {
492
+				$model_routes[ $plural_model_route ][] = array(
493
+					'callback'        => array(
494
+						'EventEspresso\core\libraries\rest_api\controllers\model\Write',
495
+						'handleRequestInsert',
496
+					),
497
+					'callback_args'   => array($version, $model_name),
498
+					'methods'         => WP_REST_Server::CREATABLE,
499
+					'hidden_endpoint' => $hidden_endpoint,
500
+					'args'            => $this->_get_write_params($model_name, $model_version_info, true),
501
+				);
502
+				$model_routes[ $singular_model_route ] = array_merge(
503
+					$model_routes[ $singular_model_route ],
504
+					array(
505
+						array(
506
+							'callback'        => array(
507
+								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
508
+								'handleRequestUpdate',
509
+							),
510
+							'callback_args'   => array($version, $model_name),
511
+							'methods'         => WP_REST_Server::EDITABLE,
512
+							'hidden_endpoint' => $hidden_endpoint,
513
+							'args'            => $this->_get_write_params($model_name, $model_version_info),
514
+						),
515
+						array(
516
+							'callback'        => array(
517
+								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
518
+								'handleRequestDelete',
519
+							),
520
+							'callback_args'   => array($version, $model_name),
521
+							'methods'         => WP_REST_Server::DELETABLE,
522
+							'hidden_endpoint' => $hidden_endpoint,
523
+							'args'            => $this->_get_delete_query_params($model, $version),
524
+						),
525
+					)
526
+				);
527
+			}
528
+			foreach ($model->relation_settings() as $relation_name => $relation_obj) {
529
+				$related_route = EED_Core_Rest_Api::get_relation_route_via(
530
+					$model,
531
+					'(?P<id>[^\/]+)',
532
+					$relation_obj
533
+				);
534
+				$endpoints = array(
535
+					array(
536
+						'callback'        => array(
537
+							'EventEspresso\core\libraries\rest_api\controllers\model\Read',
538
+							'handleRequestGetRelated',
539
+						),
540
+						'callback_args'   => array($version, $model_name, $relation_name),
541
+						'methods'         => WP_REST_Server::READABLE,
542
+						'hidden_endpoint' => $hidden_endpoint,
543
+						'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
544
+					),
545
+				);
546
+				$model_routes[ $related_route ] = $endpoints;
547
+			}
548
+		}
549
+		return $model_routes;
550
+	}
551
+
552
+
553
+	/**
554
+	 * Gets the relative URI to a model's REST API plural route, after the EE4 versioned namespace,
555
+	 * excluding the preceding slash.
556
+	 * Eg you pass get_plural_route_to('Event') = 'events'
557
+	 *
558
+	 * @param EEM_Base $model
559
+	 * @return string
560
+	 */
561
+	public static function get_collection_route(EEM_Base $model)
562
+	{
563
+		return EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
564
+	}
565
+
566
+
567
+	/**
568
+	 * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
569
+	 * excluding the preceding slash.
570
+	 * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
571
+	 *
572
+	 * @param EEM_Base $model eg Event or Venue
573
+	 * @param string   $id
574
+	 * @return string
575
+	 */
576
+	public static function get_entity_route($model, $id)
577
+	{
578
+		return EED_Core_Rest_Api::get_collection_route($model) . '/' . $id;
579
+	}
580
+
581
+
582
+	/**
583
+	 * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
584
+	 * excluding the preceding slash.
585
+	 * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
586
+	 *
587
+	 * @param EEM_Base               $model eg Event or Venue
588
+	 * @param string                 $id
589
+	 * @param EE_Model_Relation_Base $relation_obj
590
+	 * @return string
591
+	 */
592
+	public static function get_relation_route_via(EEM_Base $model, $id, EE_Model_Relation_Base $relation_obj)
593
+	{
594
+		$related_model_name_endpoint_part = ModelRead::getRelatedEntityName(
595
+			$relation_obj->get_other_model()->get_this_model_name(),
596
+			$relation_obj
597
+		);
598
+		return EED_Core_Rest_Api::get_entity_route($model, $id) . '/' . $related_model_name_endpoint_part;
599
+	}
600
+
601
+
602
+	/**
603
+	 * Adds onto the $relative_route the EE4 REST API versioned namespace.
604
+	 * Eg if given '4.8.36' and 'events', will return 'ee/v4.8.36/events'
605
+	 *
606
+	 * @param string $relative_route
607
+	 * @param string $version
608
+	 * @return string
609
+	 */
610
+	public static function get_versioned_route_to($relative_route, $version = '4.8.36')
611
+	{
612
+		return '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/' . $relative_route;
613
+	}
614
+
615
+
616
+	/**
617
+	 * Adds all the RPC-style routes (remote procedure call-like routes, ie
618
+	 * routes that don't conform to the traditional REST CRUD-style).
619
+	 *
620
+	 * @deprecated since 4.9.1
621
+	 */
622
+	protected function _register_rpc_routes()
623
+	{
624
+		$routes = array();
625
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
626
+			$routes[ self::ee_api_namespace . $version ] = $this->_get_rpc_route_data_for_version(
627
+				$version,
628
+				$hidden_endpoint
629
+			);
630
+		}
631
+		return $routes;
632
+	}
633
+
634
+
635
+	/**
636
+	 * @param string  $version
637
+	 * @param boolean $hidden_endpoint
638
+	 * @return array
639
+	 */
640
+	protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false)
641
+	{
642
+		$this_versions_routes = array();
643
+		// checkin endpoint
644
+		$this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = array(
645
+			array(
646
+				'callback'        => array(
647
+					'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
648
+					'handleRequestToggleCheckin',
649
+				),
650
+				'methods'         => WP_REST_Server::CREATABLE,
651
+				'hidden_endpoint' => $hidden_endpoint,
652
+				'args'            => array(
653
+					'force' => array(
654
+						'required'    => false,
655
+						'default'     => false,
656
+						'description' => __(
657
+						// @codingStandardsIgnoreStart
658
+							'Whether to force toggle checkin, or to verify the registration status and allowed ticket uses',
659
+							// @codingStandardsIgnoreEnd
660
+							'event_espresso'
661
+						),
662
+					),
663
+				),
664
+				'callback_args'   => array($version),
665
+			),
666
+		);
667
+		return apply_filters(
668
+			'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
669
+			$this_versions_routes,
670
+			$version,
671
+			$hidden_endpoint
672
+		);
673
+	}
674
+
675
+
676
+	/**
677
+	 * Gets the query params that can be used when request one or many
678
+	 *
679
+	 * @param EEM_Base $model
680
+	 * @param string   $version
681
+	 * @return array
682
+	 */
683
+	protected function _get_response_selection_query_params(\EEM_Base $model, $version)
684
+	{
685
+		return apply_filters(
686
+			'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
687
+			array(
688
+				'include'   => array(
689
+					'required' => false,
690
+					'default'  => '*',
691
+					'type'     => 'string',
692
+				),
693
+				'calculate' => array(
694
+					'required'          => false,
695
+					'default'           => '',
696
+					'enum'              => self::$_field_calculator->retrieveCalculatedFieldsForModel($model),
697
+					'type'              => 'string',
698
+					// because we accept a CSV'd list of the enumerated strings, WP core validation and sanitization
699
+					// freaks out. We'll just validate this argument while handling the request
700
+					'validate_callback' => null,
701
+					'sanitize_callback' => null,
702
+				),
703
+			),
704
+			$model,
705
+			$version
706
+		);
707
+	}
708
+
709
+
710
+	/**
711
+	 * Gets the parameters acceptable for delete requests
712
+	 *
713
+	 * @param \EEM_Base $model
714
+	 * @param string    $version
715
+	 * @return array
716
+	 */
717
+	protected function _get_delete_query_params(\EEM_Base $model, $version)
718
+	{
719
+		$params_for_delete = array(
720
+			'allow_blocking' => array(
721
+				'required' => false,
722
+				'default'  => true,
723
+				'type'     => 'boolean',
724
+			),
725
+		);
726
+		$params_for_delete['force'] = array(
727
+			'required' => false,
728
+			'default'  => false,
729
+			'type'     => 'boolean',
730
+		);
731
+		return apply_filters(
732
+			'FHEE__EED_Core_Rest_Api___get_delete_query_params',
733
+			$params_for_delete,
734
+			$model,
735
+			$version
736
+		);
737
+	}
738
+
739
+
740
+	/**
741
+	 * Gets info about reading query params that are acceptable
742
+	 *
743
+	 * @param \EEM_Base $model eg 'Event' or 'Venue'
744
+	 * @param  string   $version
745
+	 * @return array    describing the args acceptable when querying this model
746
+	 * @throws EE_Error
747
+	 */
748
+	protected function _get_read_query_params(\EEM_Base $model, $version)
749
+	{
750
+		$default_orderby = array();
751
+		foreach ($model->get_combined_primary_key_fields() as $key_field) {
752
+			$default_orderby[ $key_field->get_name() ] = 'ASC';
753
+		}
754
+		return array_merge(
755
+			$this->_get_response_selection_query_params($model, $version),
756
+			array(
757
+				'where'    => array(
758
+					'required'          => false,
759
+					'default'           => array(),
760
+					'type'              => 'object',
761
+					// because we accept an almost infinite list of possible where conditions, WP
762
+					// core validation and sanitization freaks out. We'll just validate this argument
763
+					// while handling the request
764
+					'validate_callback' => null,
765
+					'sanitize_callback' => null,
766
+				),
767
+				'limit'    => array(
768
+					'required'          => false,
769
+					'default'           => EED_Core_Rest_Api::get_default_query_limit(),
770
+					'type'              => array(
771
+						'array',
772
+						'string',
773
+						'integer',
774
+					),
775
+					// because we accept a variety of types, WP core validation and sanitization
776
+					// freaks out. We'll just validate this argument while handling the request
777
+					'validate_callback' => null,
778
+					'sanitize_callback' => null,
779
+				),
780
+				'order_by' => array(
781
+					'required'          => false,
782
+					'default'           => $default_orderby,
783
+					'type'              => array(
784
+						'object',
785
+						'string',
786
+					),// because we accept a variety of types, WP core validation and sanitization
787
+					// freaks out. We'll just validate this argument while handling the request
788
+					'validate_callback' => null,
789
+					'sanitize_callback' => null,
790
+				),
791
+				'group_by' => array(
792
+					'required'          => false,
793
+					'default'           => null,
794
+					'type'              => array(
795
+						'object',
796
+						'string',
797
+					),
798
+					// because we accept  an almost infinite list of possible groupings,
799
+					// WP core validation and sanitization
800
+					// freaks out. We'll just validate this argument while handling the request
801
+					'validate_callback' => null,
802
+					'sanitize_callback' => null,
803
+				),
804
+				'having'   => array(
805
+					'required'          => false,
806
+					'default'           => null,
807
+					'type'              => 'object',
808
+					// because we accept an almost infinite list of possible where conditions, WP
809
+					// core validation and sanitization freaks out. We'll just validate this argument
810
+					// while handling the request
811
+					'validate_callback' => null,
812
+					'sanitize_callback' => null,
813
+				),
814
+				'caps'     => array(
815
+					'required' => false,
816
+					'default'  => EEM_Base::caps_read,
817
+					'type'     => 'string',
818
+					'enum'     => array(
819
+						EEM_Base::caps_read,
820
+						EEM_Base::caps_read_admin,
821
+						EEM_Base::caps_edit,
822
+						EEM_Base::caps_delete,
823
+					),
824
+				),
825
+			)
826
+		);
827
+	}
828
+
829
+
830
+	/**
831
+	 * Gets parameter information for a model regarding writing data
832
+	 *
833
+	 * @param string           $model_name
834
+	 * @param ModelVersionInfo $model_version_info
835
+	 * @param boolean          $create                                       whether this is for request to create (in
836
+	 *                                                                       which case we need all required params) or
837
+	 *                                                                       just to update (in which case we don't
838
+	 *                                                                       need those on every request)
839
+	 * @return array
840
+	 */
841
+	protected function _get_write_params(
842
+		$model_name,
843
+		ModelVersionInfo $model_version_info,
844
+		$create = false
845
+	) {
846
+		$model = EE_Registry::instance()->load_model($model_name);
847
+		$fields = $model_version_info->fieldsOnModelInThisVersion($model);
848
+		$args_info = array();
849
+		foreach ($fields as $field_name => $field_obj) {
850
+			if ($field_obj->is_auto_increment()) {
851
+				// totally ignore auto increment IDs
852
+				continue;
853
+			}
854
+			$arg_info = $field_obj->getSchema();
855
+			$required = $create && ! $field_obj->is_nullable() && $field_obj->get_default_value() === null;
856
+			$arg_info['required'] = $required;
857
+			// remove the read-only flag. If it were read-only we wouldn't list it as an argument while writing, right?
858
+			unset($arg_info['readonly']);
859
+			$schema_properties = $field_obj->getSchemaProperties();
860
+			if (isset($schema_properties['raw'])
861
+				&& $field_obj->getSchemaType() === 'object'
862
+			) {
863
+				// if there's a "raw" form of this argument, use those properties instead
864
+				$arg_info = array_replace(
865
+					$arg_info,
866
+					$schema_properties['raw']
867
+				);
868
+			}
869
+			$arg_info['default'] = ModelDataTranslator::prepareFieldValueForJson(
870
+				$field_obj,
871
+				$field_obj->get_default_value(),
872
+				$model_version_info->requestedVersion()
873
+			);
874
+			// we do our own validation and sanitization within the controller
875
+			if (function_exists('rest_validate_value_from_schema')) {
876
+				$sanitize_callback = array(
877
+					'EED_Core_Rest_Api',
878
+					'default_sanitize_callback',
879
+				);
880
+			} else {
881
+				$sanitize_callback = null;
882
+			}
883
+			$arg_info['sanitize_callback'] = $sanitize_callback;
884
+			$args_info[ $field_name ] = $arg_info;
885
+			if ($field_obj instanceof EE_Datetime_Field) {
886
+				$gmt_arg_info = $arg_info;
887
+				$gmt_arg_info['description'] = sprintf(
888
+					esc_html__(
889
+						'%1$s - the value for this field in UTC. Ignored if %2$s is provided.',
890
+						'event_espresso'
891
+					),
892
+					$field_obj->get_nicename(),
893
+					$field_name
894
+				);
895
+				$args_info[ $field_name . '_gmt' ] = $gmt_arg_info;
896
+			}
897
+		}
898
+		return $args_info;
899
+	}
900
+
901
+
902
+	/**
903
+	 * Replacement for WP API's 'rest_parse_request_arg'.
904
+	 * If the value is blank but not required, don't bother validating it.
905
+	 * Also, it uses our email validation instead of WP API's default.
906
+	 *
907
+	 * @param                 $value
908
+	 * @param WP_REST_Request $request
909
+	 * @param                 $param
910
+	 * @return bool|true|WP_Error
911
+	 * @throws InvalidArgumentException
912
+	 * @throws InvalidInterfaceException
913
+	 * @throws InvalidDataTypeException
914
+	 */
915
+	public static function default_sanitize_callback($value, WP_REST_Request $request, $param)
916
+	{
917
+		$attributes = $request->get_attributes();
918
+		if (! isset($attributes['args'][ $param ])
919
+			|| ! is_array($attributes['args'][ $param ])) {
920
+			$validation_result = true;
921
+		} else {
922
+			$args = $attributes['args'][ $param ];
923
+			if ((
924
+					$value === ''
925
+					|| $value === null
926
+				)
927
+				&& (! isset($args['required'])
928
+					|| $args['required'] === false
929
+				)
930
+			) {
931
+				// not required and not provided? that's cool
932
+				$validation_result = true;
933
+			} elseif (isset($args['format'])
934
+					  && $args['format'] === 'email'
935
+			) {
936
+				$validation_result = true;
937
+				if (! self::_validate_email($value)) {
938
+					$validation_result = new WP_Error(
939
+						'rest_invalid_param',
940
+						esc_html__(
941
+							'The email address is not valid or does not exist.',
942
+							'event_espresso'
943
+						)
944
+					);
945
+				}
946
+			} else {
947
+				$validation_result = rest_validate_value_from_schema($value, $args, $param);
948
+			}
949
+		}
950
+		if (is_wp_error($validation_result)) {
951
+			return $validation_result;
952
+		}
953
+		return rest_sanitize_request_arg($value, $request, $param);
954
+	}
955
+
956
+
957
+	/**
958
+	 * Returns whether or not this email address is valid. Copied from EE_Email_Validation_Strategy::_validate_email()
959
+	 *
960
+	 * @param $email
961
+	 * @return bool
962
+	 * @throws InvalidArgumentException
963
+	 * @throws InvalidInterfaceException
964
+	 * @throws InvalidDataTypeException
965
+	 */
966
+	protected static function _validate_email($email)
967
+	{
968
+		try {
969
+			EmailAddressFactory::create($email);
970
+			return true;
971
+		} catch (EmailValidationException $e) {
972
+			return false;
973
+		}
974
+	}
975
+
976
+
977
+	/**
978
+	 * Gets routes for the config
979
+	 *
980
+	 * @return array @see _register_model_routes
981
+	 * @deprecated since version 4.9.1
982
+	 */
983
+	protected function _register_config_routes()
984
+	{
985
+		$config_routes = array();
986
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
987
+			$config_routes[ self::ee_api_namespace . $version ] = $this->_get_config_route_data_for_version(
988
+				$version,
989
+				$hidden_endpoint
990
+			);
991
+		}
992
+		return $config_routes;
993
+	}
994
+
995
+
996
+	/**
997
+	 * Gets routes for the config for the specified version
998
+	 *
999
+	 * @param string  $version
1000
+	 * @param boolean $hidden_endpoint
1001
+	 * @return array
1002
+	 */
1003
+	protected function _get_config_route_data_for_version($version, $hidden_endpoint)
1004
+	{
1005
+		return array(
1006
+			'config'    => array(
1007
+				array(
1008
+					'callback'        => array(
1009
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
1010
+						'handleRequest',
1011
+					),
1012
+					'methods'         => WP_REST_Server::READABLE,
1013
+					'hidden_endpoint' => $hidden_endpoint,
1014
+					'callback_args'   => array($version),
1015
+				),
1016
+			),
1017
+			'site_info' => array(
1018
+				array(
1019
+					'callback'        => array(
1020
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
1021
+						'handleRequestSiteInfo',
1022
+					),
1023
+					'methods'         => WP_REST_Server::READABLE,
1024
+					'hidden_endpoint' => $hidden_endpoint,
1025
+					'callback_args'   => array($version),
1026
+				),
1027
+			),
1028
+		);
1029
+	}
1030
+
1031
+
1032
+	/**
1033
+	 * Gets the meta info routes
1034
+	 *
1035
+	 * @return array @see _register_model_routes
1036
+	 * @deprecated since version 4.9.1
1037
+	 */
1038
+	protected function _register_meta_routes()
1039
+	{
1040
+		$meta_routes = array();
1041
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
1042
+			$meta_routes[ self::ee_api_namespace . $version ] = $this->_get_meta_route_data_for_version(
1043
+				$version,
1044
+				$hidden_endpoint
1045
+			);
1046
+		}
1047
+		return $meta_routes;
1048
+	}
1049
+
1050
+
1051
+	/**
1052
+	 * @param string  $version
1053
+	 * @param boolean $hidden_endpoint
1054
+	 * @return array
1055
+	 */
1056
+	protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false)
1057
+	{
1058
+		return array(
1059
+			'resources' => array(
1060
+				array(
1061
+					'callback'        => array(
1062
+						'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
1063
+						'handleRequestModelsMeta',
1064
+					),
1065
+					'methods'         => WP_REST_Server::READABLE,
1066
+					'hidden_endpoint' => $hidden_endpoint,
1067
+					'callback_args'   => array($version),
1068
+				),
1069
+			),
1070
+		);
1071
+	}
1072
+
1073
+
1074
+	/**
1075
+	 * Tries to hide old 4.6 endpoints from the
1076
+	 *
1077
+	 * @param array $route_data
1078
+	 * @return array
1079
+	 * @throws \EE_Error
1080
+	 */
1081
+	public static function hide_old_endpoints($route_data)
1082
+	{
1083
+		// allow API clients to override which endpoints get hidden, in case
1084
+		// they want to discover particular endpoints
1085
+		// also, we don't have access to the request so we have to just grab it from the superglobal
1086
+		$force_show_ee_namespace = ltrim(
1087
+			EEH_Array::is_set($_REQUEST, 'force_show_ee_namespace', ''),
1088
+			'/'
1089
+		);
1090
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
1091
+			foreach ($relative_urls as $resource_name => $endpoints) {
1092
+				foreach ($endpoints as $key => $endpoint) {
1093
+					// skip schema and other route options
1094
+					if (! is_numeric($key)) {
1095
+						continue;
1096
+					}
1097
+					// by default, hide "hidden_endpoint"s, unless the request indicates
1098
+					// to $force_show_ee_namespace, in which case only show that one
1099
+					// namespace's endpoints (and hide all others)
1100
+					if (($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
1101
+						|| ($endpoint['hidden_endpoint'] && $force_show_ee_namespace === '')
1102
+					) {
1103
+						$full_route = '/' . ltrim($namespace, '/');
1104
+						$full_route .= '/' . ltrim($resource_name, '/');
1105
+						unset($route_data[ $full_route ]);
1106
+					}
1107
+				}
1108
+			}
1109
+		}
1110
+		return $route_data;
1111
+	}
1112
+
1113
+
1114
+	/**
1115
+	 * Returns an array describing which versions of core support serving requests for.
1116
+	 * Keys are core versions' major and minor version, and values are the
1117
+	 * LOWEST requested version they can serve. Eg, 4.7 can serve requests for 4.6-like
1118
+	 * data by just removing a few models and fields from the responses. However, 4.15 might remove
1119
+	 * the answers table entirely, in which case it would be very difficult for
1120
+	 * it to serve 4.6-style responses.
1121
+	 * Versions of core that are missing from this array are unknowns.
1122
+	 * previous ver
1123
+	 *
1124
+	 * @return array
1125
+	 */
1126
+	public static function version_compatibilities()
1127
+	{
1128
+		return apply_filters(
1129
+			'FHEE__EED_Core_REST_API__version_compatibilities',
1130
+			array(
1131
+				'4.8.29' => '4.8.29',
1132
+				'4.8.33' => '4.8.29',
1133
+				'4.8.34' => '4.8.29',
1134
+				'4.8.36' => '4.8.29',
1135
+			)
1136
+		);
1137
+	}
1138
+
1139
+
1140
+	/**
1141
+	 * Gets the latest API version served. Eg if there
1142
+	 * are two versions served of the API, 4.8.29 and 4.8.32, and
1143
+	 * we are on core version 4.8.34, it will return the string "4.8.32"
1144
+	 *
1145
+	 * @return string
1146
+	 */
1147
+	public static function latest_rest_api_version()
1148
+	{
1149
+		$versions_served = \EED_Core_Rest_Api::versions_served();
1150
+		$versions_served_keys = array_keys($versions_served);
1151
+		return end($versions_served_keys);
1152
+	}
1153
+
1154
+
1155
+	/**
1156
+	 * Using EED_Core_Rest_Api::version_compatibilities(), determines what version of
1157
+	 * EE the API can serve requests for. Eg, if we are on 4.15 of core, and
1158
+	 * we can serve requests from 4.12 or later, this will return array( '4.12', '4.13', '4.14', '4.15' ).
1159
+	 * We also indicate whether or not this version should be put in the index or not
1160
+	 *
1161
+	 * @return array keys are API version numbers (just major and minor numbers), and values
1162
+	 * are whether or not they should be hidden
1163
+	 */
1164
+	public static function versions_served()
1165
+	{
1166
+		$versions_served = array();
1167
+		$possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
1168
+		$lowest_compatible_version = end($possibly_served_versions);
1169
+		reset($possibly_served_versions);
1170
+		$versions_served_historically = array_keys($possibly_served_versions);
1171
+		$latest_version = end($versions_served_historically);
1172
+		reset($versions_served_historically);
1173
+		// for each version of core we have ever served:
1174
+		foreach ($versions_served_historically as $key_versioned_endpoint) {
1175
+			// if it's not above the current core version, and it's compatible with the current version of core
1176
+			if ($key_versioned_endpoint === $latest_version) {
1177
+				// don't hide the latest version in the index
1178
+				$versions_served[ $key_versioned_endpoint ] = false;
1179
+			} elseif ($key_versioned_endpoint >= $lowest_compatible_version
1180
+				&& $key_versioned_endpoint < EED_Core_Rest_Api::core_version()
1181
+			) {
1182
+				// include, but hide, previous versions which are still supported
1183
+				$versions_served[ $key_versioned_endpoint ] = true;
1184
+			} elseif (apply_filters(
1185
+				'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
1186
+				false,
1187
+				$possibly_served_versions
1188
+			)) {
1189
+				// if a version is no longer supported, don't include it in index or list of versions served
1190
+				$versions_served[ $key_versioned_endpoint ] = true;
1191
+			}
1192
+		}
1193
+		return $versions_served;
1194
+	}
1195
+
1196
+
1197
+	/**
1198
+	 * Gets the major and minor version of EE core's version string
1199
+	 *
1200
+	 * @return string
1201
+	 */
1202
+	public static function core_version()
1203
+	{
1204
+		return apply_filters(
1205
+			'FHEE__EED_Core_REST_API__core_version',
1206
+			implode(
1207
+				'.',
1208
+				array_slice(
1209
+					explode(
1210
+						'.',
1211
+						espresso_version()
1212
+					),
1213
+					0,
1214
+					3
1215
+				)
1216
+			)
1217
+		);
1218
+	}
1219
+
1220
+
1221
+	/**
1222
+	 * Gets the default limit that should be used when querying for resources
1223
+	 *
1224
+	 * @return int
1225
+	 */
1226
+	public static function get_default_query_limit()
1227
+	{
1228
+		// we actually don't use a const because we want folks to always use
1229
+		// this method, not the const directly
1230
+		return apply_filters(
1231
+			'FHEE__EED_Core_Rest_Api__get_default_query_limit',
1232
+			50
1233
+		);
1234
+	}
1235
+
1236
+
1237
+	/**
1238
+	 *
1239
+	 * @param string $version api version string (i.e. '4.8.36')
1240
+	 * @return array
1241
+	 */
1242
+	public static function getCollectionRoutesIndexedByModelName($version = '')
1243
+	{
1244
+		$version = empty($version) ? self::latest_rest_api_version() : $version;
1245
+		$model_names = self::model_names_with_plural_routes($version);
1246
+		$collection_routes = array();
1247
+		foreach ($model_names as $model_name => $model_class_name) {
1248
+			$collection_routes[ strtolower($model_name) ] = '/' . self::ee_api_namespace . $version . '/'
1249
+															. EEH_Inflector::pluralize_and_lower($model_name);
1250
+		}
1251
+		return $collection_routes;
1252
+	}
1253
+
1254
+
1255
+	/**
1256
+	 * Returns an array of primary key names indexed by model names.
1257
+	 * @param string $version
1258
+	 * @return array
1259
+	 */
1260
+	public static function getPrimaryKeyNamesIndexedByModelName($version = '')
1261
+	{
1262
+		$version = empty($version) ? self::latest_rest_api_version() : $version;
1263
+		$model_names = self::model_names_with_plural_routes($version);
1264
+		$primary_key_items = array();
1265
+		foreach ($model_names as $model_name => $model_class_name) {
1266
+			$primary_keys = $model_class_name::instance()->get_combined_primary_key_fields();
1267
+			foreach ($primary_keys as $primary_key_name => $primary_key_field) {
1268
+				if (count($primary_keys) > 1) {
1269
+					$primary_key_items[ strtolower($model_name) ][] = $primary_key_name;
1270
+				} else {
1271
+					$primary_key_items[ strtolower($model_name) ] = $primary_key_name;
1272
+				}
1273
+			}
1274
+		}
1275
+		return $primary_key_items;
1276
+	}
1277
+
1278
+
1279
+
1280
+	/**
1281
+	 *    run - initial module setup
1282
+	 *
1283
+	 * @access    public
1284
+	 * @param  WP $WP
1285
+	 * @return    void
1286
+	 */
1287
+	public function run($WP)
1288
+	{
1289
+	}
1290 1290
 }
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.
caffeinated/payment_methods/Aim/EEG_Aim.gateway.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -362,7 +362,7 @@
 block discarded – undo
362 362
     /**
363 363
      * Posts the request to AuthorizeNet & returns response.
364 364
      *
365
-     * @param $payment
365
+     * @param EEI_Payment $payment
366 366
      * @return \EE_AuthorizeNetAIM_Response
367 367
      */
368 368
     private function _sendRequest($payment)
Please login to merge, or discard this patch.
Spacing   +11 added lines, -11 removed lines patch added patch discarded remove patch
@@ -248,7 +248,7 @@  discard block
 block discarded – undo
248 248
         // invoice_num would be nice to have it be unique per SPCO page-load, that way if users
249 249
         // press back, they don't submit a duplicate. However, we may be keeping the user on teh same spco page
250 250
         // in which case, we need to generate teh invoice num per request right here...
251
-        $this->setField('invoice_num', wp_generate_password(12, false));// $billing_info['_reg-page-billing-invoice-'.$this->_gateway_name]['value']);
251
+        $this->setField('invoice_num', wp_generate_password(12, false)); // $billing_info['_reg-page-billing-invoice-'.$this->_gateway_name]['value']);
252 252
         // tell AIM that any duplicates sent in the next 5 minutes are to be ignored
253 253
         $this->setField('duplicate_window', 5 * MINUTE_IN_SECONDS);
254 254
 
@@ -259,7 +259,7 @@  discard block
 block discarded – undo
259 259
         // Capture response
260 260
         $this->type = "AUTH_CAPTURE";
261 261
         $response = $this->_sendRequest($payment);
262
-        if (! empty($response)) {
262
+        if ( ! empty($response)) {
263 263
             if ($response->error_message) {
264 264
                 $payment->set_status($this->_pay_model->failed_status());
265 265
                 $payment->set_gateway_response($response->error_message);
@@ -305,7 +305,7 @@  discard block
 block discarded – undo
305 305
     protected function _set_sensitive_billing_data($billing_info)
306 306
     {
307 307
         $this->setField('card_num', $billing_info['credit_card']);
308
-        $this->setField('exp_date', $billing_info['exp_month'] . $billing_info['exp_year']);
308
+        $this->setField('exp_date', $billing_info['exp_month'].$billing_info['exp_year']);
309 309
         $this->setField('card_code', $billing_info['cvv']);
310 310
     }
311 311
 
@@ -345,7 +345,7 @@  discard block
 block discarded – undo
345 345
     protected function setField($name, $value)
346 346
     {
347 347
         if (in_array($name, $this->_all_aim_fields)) {
348
-            $this->_x_post_fields[ $name ] = $value;
348
+            $this->_x_post_fields[$name] = $value;
349 349
         } else {
350 350
             throw new AuthorizeNetException("Error: no field $name exists in the AIM API.
351 351
             To set a custom field use setCustomField('field','value') instead.");
@@ -365,11 +365,11 @@  discard block
 block discarded – undo
365 365
         $this->_x_post_fields['tran_key'] = $this->_transaction_key;
366 366
         $x_keys = array();
367 367
         foreach ($this->_x_post_fields as $key => $value) {
368
-            $x_keys[] = "x_$key=" . urlencode($this->_get_unsupported_character_remover()->format($value));
368
+            $x_keys[] = "x_$key=".urlencode($this->_get_unsupported_character_remover()->format($value));
369 369
         }
370 370
         // Add line items
371 371
         foreach ($this->_additional_line_items as $key => $value) {
372
-            $x_keys[] =  "x_line_item=" . urlencode($this->_get_unsupported_character_remover()->format($value));
372
+            $x_keys[] = "x_line_item=".urlencode($this->_get_unsupported_character_remover()->format($value));
373 373
         }
374 374
         $this->_log_clean_request($x_keys, $payment);
375 375
         $post_url = $this->_get_server_url();
@@ -381,7 +381,7 @@  discard block
 block discarded – undo
381 381
         curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);
382 382
         curl_setopt($curl_request, CURLOPT_SSL_VERIFYHOST, 2);
383 383
         if ($this->VERIFY_PEER) {
384
-            curl_setopt($curl_request, CURLOPT_CAINFO, dirname(__DIR__) . '/ssl/cert.pem');
384
+            curl_setopt($curl_request, CURLOPT_CAINFO, dirname(__DIR__).'/ssl/cert.pem');
385 385
         } else {
386 386
             curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, false);
387 387
         }
@@ -393,7 +393,7 @@  discard block
 block discarded – undo
393 393
         $response = curl_exec($curl_request);
394 394
 
395 395
         curl_close($curl_request);
396
-        $response_obj =  new EE_AuthorizeNetAIM_Response($response);
396
+        $response_obj = new EE_AuthorizeNetAIM_Response($response);
397 397
 
398 398
         return $this->_log_and_clean_response($response_obj, $payment);
399 399
     }
@@ -413,7 +413,7 @@  discard block
 block discarded – undo
413 413
                 if (strpos($keyvaltogether, $key) === 0) {
414 414
                     // found it at the first character
415 415
                     // so its one of them
416
-                    unset($request_array[ $index ]);
416
+                    unset($request_array[$index]);
417 417
                 }
418 418
             }
419 419
         }
@@ -539,7 +539,7 @@  discard block
 block discarded – undo
539 539
             // Split Array
540 540
             $this->response = $response;
541 541
             if ($encap_char) {
542
-                $this->_response_array = explode($encap_char . $delimiter . $encap_char, substr($response, 1, -1));
542
+                $this->_response_array = explode($encap_char.$delimiter.$encap_char, substr($response, 1, -1));
543 543
             } else {
544 544
                 $this->_response_array = explode($delimiter, $response);
545 545
             }
@@ -621,7 +621,7 @@  discard block
 block discarded – undo
621 621
     }
622 622
 }
623 623
 
624
-if (! class_exists('AuthorizeNetException')) {
624
+if ( ! class_exists('AuthorizeNetException')) {
625 625
     /**
626 626
      * Class AuthorizeNetException
627 627
      *
Please login to merge, or discard this patch.
Indentation   +605 added lines, -605 removed lines patch added patch discarded remove patch
@@ -25,427 +25,427 @@  discard block
 block discarded – undo
25 25
 class EEG_Aim extends EE_Onsite_Gateway
26 26
 {
27 27
 
28
-    const LIVE_URL    = 'https://secure2.authorize.net/gateway/transact.dll'; // Authnet URL
29
-
30
-    const SANDBOX_URL = 'https://test.authorize.net/gateway/transact.dll';
31
-
32
-    protected $_login_id;
33
-
34
-    protected $_transaction_key;
35
-
36
-    protected $_server;
37
-
38
-    protected $_currencies_supported = array(
39
-        'AUD',
40
-        'USD',
41
-        'CAD',
42
-        'EUR',
43
-        'GBP',
44
-        'NZD',
45
-    );
46
-
47
-    /**
48
-     * Whether to send test transactions (even to live site)
49
-     *
50
-     * @var boolean
51
-     */
52
-    protected $_test_transactions;
53
-
54
-    private $VERIFY_PEER = false;
55
-
56
-    private $_x_post_fields = array(
57
-        "version"        => "3.1",
58
-        "delim_char"     => ",",
59
-        "delim_data"     => "TRUE",
60
-        "relay_response" => "FALSE",
61
-        "encap_char"     => "|",
62
-    );
63
-
64
-    private $_additional_line_items = array();
65
-
66
-    /**
67
-     * A list of all fields in the AIM API.
68
-     * Used to warn user if they try to set a field not offered in the API.
69
-     */
70
-    private $_all_aim_fields = array(
71
-        "address",
72
-        "allow_partial_auth",
73
-        "amount",
74
-        "auth_code",
75
-        "authentication_indicator",
76
-        "bank_aba_code",
77
-        "bank_acct_name",
78
-        "bank_acct_num",
79
-        "bank_acct_type",
80
-        "bank_check_number",
81
-        "bank_name",
82
-        "card_code",
83
-        "card_num",
84
-        "cardholder_authentication_value",
85
-        "city",
86
-        "company",
87
-        "country",
88
-        "cust_id",
89
-        "customer_ip",
90
-        "delim_char",
91
-        "delim_data",
92
-        "description",
93
-        "duplicate_window",
94
-        "duty",
95
-        "echeck_type",
96
-        "email",
97
-        "email_customer",
98
-        "encap_char",
99
-        "exp_date",
100
-        "fax",
101
-        "first_name",
102
-        "footer_email_receipt",
103
-        "freight",
104
-        "header_email_receipt",
105
-        "invoice_num",
106
-        "last_name",
107
-        "line_item",
108
-        "login",
109
-        "method",
110
-        "phone",
111
-        "po_num",
112
-        "recurring_billing",
113
-        "relay_response",
114
-        "ship_to_address",
115
-        "ship_to_city",
116
-        "ship_to_company",
117
-        "ship_to_country",
118
-        "ship_to_first_name",
119
-        "ship_to_last_name",
120
-        "ship_to_state",
121
-        "ship_to_zip",
122
-        "split_tender_id",
123
-        "state",
124
-        "tax",
125
-        "tax_exempt",
126
-        "test_request",
127
-        "tran_key",
128
-        "trans_id",
129
-        "type",
130
-        "version",
131
-        "zip",
132
-        "solution_id",
133
-        "currency_code"
134
-    );
135
-
136
-
137
-    /**
138
-     * Gets the URL where the request should go. This is filterable
139
-     *
140
-     * @return string
141
-     */
142
-    protected function _get_server_url()
143
-    {
144
-        return apply_filters(
145
-            'FHEE__EEG_Aim___get_server_url',
146
-            $this->_debug_mode ? self::SANDBOX_URL : self::LIVE_URL,
147
-            $this
148
-        );
149
-    }
150
-
151
-
152
-    /**
153
-     * TEMPORARY CALLBACK! Do not use
154
-     * Callback which filters the server url. This is added so site admins can revert to using
155
-     * the old AIM server in case Akamai service breaks their integration.
156
-     * Using Akamai will, however, be mandatory on June 30th 2016 Authorize.net
157
-     * (see http://www.authorize.net/support/akamaifaqs/#firewall?utm_campaign=April%202016%20Technical%20Updates%20for%20Merchants.html&utm_medium=email&utm_source=Eloqua&elqTrackId=46103bdc375c411a979c2f658fc99074&elq=7026706360154fee9b6d588b27d8eb6a&elqaid=506&elqat=1&elqCampaignId=343)
158
-     * Once that happens, this will be obsolete and WILL BE REMOVED.
159
-     *
160
-     * @param string $url
161
-     * @param EEG_Aim $gateway_object
162
-     * @return string
163
-     */
164
-    public function possibly_use_deprecated_aim_server($url, EEG_Aim $gateway_object)
165
-    {
166
-        if ($gateway_object->_server === 'authorize.net' && ! $gateway_object->_debug_mode) {
167
-            return 'https://secure.authorize.net/gateway/transact.dll';
168
-        } else {
169
-            return $url;
170
-        }
171
-    }
172
-
173
-
174
-    /**
175
-     * Asks the gateway to do whatever it does to process the payment. Onsite gateways will
176
-     * usually send a request directly to the payment provider and update the payment's status based on that;
177
-     * whereas offsite gateways will usually just update the payment with the URL and query parameters to use
178
-     * for sending the request via http_remote_request()
179
-     *
180
-     * @param EEI_Payment $payment
181
-     * @param array $billing_info {
182
-     *  @type $credit_card string
183
-     *  @type $cvv string
184
-     *  @type $exp_month string
185
-     *  @type $exp_year string
186
-     *  @see parent::do_direct_payment
187
-     * }
188
-     * @return EEI_Payment updated
189
-     */
190
-    public function do_direct_payment($payment, $billing_info = null)
191
-    {
192
-        add_filter('FHEE__EEG_Aim___get_server_url', array($this, 'possibly_use_deprecated_aim_server'), 10, 2);
193
-        // Enable test mode if needed
194
-        // 4007000000027  <-- test successful visa
195
-        // 4222222222222  <-- test failure card number
196
-
197
-        $item_num = 1;
198
-        $transaction = $payment->transaction();
199
-        $gateway_formatter = $this->_get_gateway_formatter();
200
-        $order_description = $gateway_formatter->formatOrderDescription($payment);
201
-        $primary_registrant = $transaction->primary_registration();
202
-        // if we're are charging for the full amount, show the normal line items
203
-        // and the itemized total adds up properly
204
-        if ($this->_can_easily_itemize_transaction_for($payment)) {
205
-            $total_line_item = $transaction->total_line_item();
206
-            foreach ($total_line_item->get_items() as $line_item) {
207
-                if ($line_item->quantity() == 0) {
208
-                    continue;
209
-                }
210
-                $this->addLineItem(
211
-                    $item_num++,
212
-                    $gateway_formatter->formatLineItemName($line_item, $payment),
213
-                    $gateway_formatter->formatLineItemDesc($line_item, $payment),
214
-                    $line_item->quantity(),
215
-                    $line_item->unit_price(),
216
-                    'N'
217
-                );
218
-                $order_description .= $line_item->desc().', ';
219
-            }
220
-            foreach ($total_line_item->tax_descendants() as $tax_line_item) {
221
-                $this->addLineItem(
222
-                    $item_num++,
223
-                    $tax_line_item->name(),
224
-                    $tax_line_item->desc(),
225
-                    1,
226
-                    $tax_line_item->total(),
227
-                    'N'
228
-                );
229
-            }
230
-        }
231
-
232
-        // start transaction
233
-        // if in debug mode, use authorize.net's sandbox id; otherwise use the Event Espresso partner id
234
-        $partner_id = $this->_debug_mode ? 'AAA100302' : 'AAA105363';
235
-        $this->setField('solution_id', $partner_id);
236
-        $this->setField('amount', $gateway_formatter->formatCurrency($payment->amount()));
237
-        $this->setField('description', substr(rtrim($order_description, ', '), 0, 255));
238
-        $this->_set_sensitive_billing_data($billing_info);
239
-        $this->setField('first_name', $billing_info['first_name']);
240
-        $this->setField('last_name', $billing_info['last_name']);
241
-        $this->setField('email', $billing_info['email']);
242
-        $this->setField('company', $billing_info['company']);
243
-        $this->setField('address', $billing_info['address'].' '.$billing_info['address2']);
244
-        $this->setField('city', $billing_info['city']);
245
-        $this->setField('state', $billing_info['state']);
246
-        $this->setField('country', $billing_info['country']);
247
-        $this->setField('zip', $billing_info['zip']);
248
-        $this->setField('fax', $billing_info['fax']);
249
-        $this->setField('cust_id', $primary_registrant->ID());
250
-        $this->setField('phone', $billing_info['phone']);
251
-        $currency_config = LoaderFactory::getLoader()->load('EE_Currency_Config');
252
-        $this->setField('currency_code', $currency_config->code);
253
-        // invoice_num would be nice to have it be unique per SPCO page-load, that way if users
254
-        // press back, they don't submit a duplicate. However, we may be keeping the user on teh same spco page
255
-        // in which case, we need to generate teh invoice num per request right here...
256
-        $this->setField('invoice_num', wp_generate_password(12, false));// $billing_info['_reg-page-billing-invoice-'.$this->_gateway_name]['value']);
257
-        // tell AIM that any duplicates sent in the next 5 minutes are to be ignored
258
-        $this->setField('duplicate_window', 5 * MINUTE_IN_SECONDS);
259
-
260
-        if ($this->_test_transactions) {
261
-            $this->test_request = "true";
262
-        }
263
-
264
-        // Capture response
265
-        $this->type = "AUTH_CAPTURE";
266
-        $response = $this->_sendRequest($payment);
267
-        if (! empty($response)) {
268
-            if ($response->error_message) {
269
-                $payment->set_status($this->_pay_model->failed_status());
270
-                $payment->set_gateway_response($response->error_message);
271
-            } else {
272
-                $payment_status = $response->approved
273
-                    ? $this->_pay_model->approved_status()
274
-                    : $this->_pay_model->declined_status();
275
-                $payment->set_status($payment_status);
276
-                // make sure we interpret the AMT as a float, not an international string (where periods are thousand separators)
277
-                $payment->set_amount((float) $response->amount);
278
-                $payment->set_gateway_response(
279
-                    sprintf(
280
-                        esc_html__('%1$s (Reason Code: %2$s)', 'event_espresso'),
281
-                        $response->response_reason_text,
282
-                        $response->response_reason_code
283
-                    )
284
-                );
285
-                if ($this->_debug_mode) {
286
-                    $txn_id = $response->invoice_number;
287
-                } else {
288
-                    $txn_id = $response->transaction_id;
289
-                }
290
-                $payment->set_txn_id_chq_nmbr($txn_id);
291
-            }
292
-            $payment->set_extra_accntng($primary_registrant->reg_code());
293
-            $payment->set_details(print_r($response, true));
294
-        } else {
295
-            $payment->set_status($this->_pay_model->failed_status());
296
-            $payment->set_gateway_response(__("There was no response from Authorize.net", 'event_espresso'));
297
-            $payment->set_details(print_r($response, true));
298
-        }
299
-        return $payment;
300
-    }
301
-
302
-
303
-    /**
304
-     * Sets billing data for the upcoming request to AIM that is considered sensitive;
305
-     * also this method can be overridden by children classes to easily change
306
-     * what billing data gets sent
307
-     *
308
-     * @param array $billing_info
309
-     */
310
-    protected function _set_sensitive_billing_data($billing_info)
311
-    {
312
-        $this->setField('card_num', $billing_info['credit_card']);
313
-        $this->setField('exp_date', $billing_info['exp_month'] . $billing_info['exp_year']);
314
-        $this->setField('card_code', $billing_info['cvv']);
315
-    }
316
-
317
-
318
-    /**
319
-     * Add a line item.
320
-     *
321
-     * @param string $item_id
322
-     * @param string $item_name
323
-     * @param string $item_description
324
-     * @param string $item_quantity
325
-     * @param string $item_unit_price
326
-     * @param string $item_taxable
327
-     */
328
-    public function addLineItem($item_id, $item_name, $item_description, $item_quantity, $item_unit_price, $item_taxable)
329
-    {
330
-        $args = array(
331
-            substr($item_id, 0, 31),
332
-            substr($item_name, 0, 31),
333
-            substr($item_description, 0, 255),
334
-            number_format(abs($item_quantity), 2, '.', ''),
335
-            number_format(abs($item_unit_price), 2, '.', ''),
336
-            $item_taxable === 'N' ? 'N' : 'Y'
337
-        );
338
-        $this->_additional_line_items[] = implode('<|>', $args);
339
-    }
340
-
341
-
342
-    /**
343
-     * Set an individual name/value pair. This will append x_ to the name
344
-     * before posting.
345
-     *
346
-     * @param string $name
347
-     * @param string $value
348
-     * @throws AuthorizeNetException
349
-     */
350
-    protected function setField($name, $value)
351
-    {
352
-        if (in_array($name, $this->_all_aim_fields)) {
353
-            $this->_x_post_fields[ $name ] = $value;
354
-        } else {
355
-            throw new AuthorizeNetException("Error: no field $name exists in the AIM API.
28
+	const LIVE_URL    = 'https://secure2.authorize.net/gateway/transact.dll'; // Authnet URL
29
+
30
+	const SANDBOX_URL = 'https://test.authorize.net/gateway/transact.dll';
31
+
32
+	protected $_login_id;
33
+
34
+	protected $_transaction_key;
35
+
36
+	protected $_server;
37
+
38
+	protected $_currencies_supported = array(
39
+		'AUD',
40
+		'USD',
41
+		'CAD',
42
+		'EUR',
43
+		'GBP',
44
+		'NZD',
45
+	);
46
+
47
+	/**
48
+	 * Whether to send test transactions (even to live site)
49
+	 *
50
+	 * @var boolean
51
+	 */
52
+	protected $_test_transactions;
53
+
54
+	private $VERIFY_PEER = false;
55
+
56
+	private $_x_post_fields = array(
57
+		"version"        => "3.1",
58
+		"delim_char"     => ",",
59
+		"delim_data"     => "TRUE",
60
+		"relay_response" => "FALSE",
61
+		"encap_char"     => "|",
62
+	);
63
+
64
+	private $_additional_line_items = array();
65
+
66
+	/**
67
+	 * A list of all fields in the AIM API.
68
+	 * Used to warn user if they try to set a field not offered in the API.
69
+	 */
70
+	private $_all_aim_fields = array(
71
+		"address",
72
+		"allow_partial_auth",
73
+		"amount",
74
+		"auth_code",
75
+		"authentication_indicator",
76
+		"bank_aba_code",
77
+		"bank_acct_name",
78
+		"bank_acct_num",
79
+		"bank_acct_type",
80
+		"bank_check_number",
81
+		"bank_name",
82
+		"card_code",
83
+		"card_num",
84
+		"cardholder_authentication_value",
85
+		"city",
86
+		"company",
87
+		"country",
88
+		"cust_id",
89
+		"customer_ip",
90
+		"delim_char",
91
+		"delim_data",
92
+		"description",
93
+		"duplicate_window",
94
+		"duty",
95
+		"echeck_type",
96
+		"email",
97
+		"email_customer",
98
+		"encap_char",
99
+		"exp_date",
100
+		"fax",
101
+		"first_name",
102
+		"footer_email_receipt",
103
+		"freight",
104
+		"header_email_receipt",
105
+		"invoice_num",
106
+		"last_name",
107
+		"line_item",
108
+		"login",
109
+		"method",
110
+		"phone",
111
+		"po_num",
112
+		"recurring_billing",
113
+		"relay_response",
114
+		"ship_to_address",
115
+		"ship_to_city",
116
+		"ship_to_company",
117
+		"ship_to_country",
118
+		"ship_to_first_name",
119
+		"ship_to_last_name",
120
+		"ship_to_state",
121
+		"ship_to_zip",
122
+		"split_tender_id",
123
+		"state",
124
+		"tax",
125
+		"tax_exempt",
126
+		"test_request",
127
+		"tran_key",
128
+		"trans_id",
129
+		"type",
130
+		"version",
131
+		"zip",
132
+		"solution_id",
133
+		"currency_code"
134
+	);
135
+
136
+
137
+	/**
138
+	 * Gets the URL where the request should go. This is filterable
139
+	 *
140
+	 * @return string
141
+	 */
142
+	protected function _get_server_url()
143
+	{
144
+		return apply_filters(
145
+			'FHEE__EEG_Aim___get_server_url',
146
+			$this->_debug_mode ? self::SANDBOX_URL : self::LIVE_URL,
147
+			$this
148
+		);
149
+	}
150
+
151
+
152
+	/**
153
+	 * TEMPORARY CALLBACK! Do not use
154
+	 * Callback which filters the server url. This is added so site admins can revert to using
155
+	 * the old AIM server in case Akamai service breaks their integration.
156
+	 * Using Akamai will, however, be mandatory on June 30th 2016 Authorize.net
157
+	 * (see http://www.authorize.net/support/akamaifaqs/#firewall?utm_campaign=April%202016%20Technical%20Updates%20for%20Merchants.html&utm_medium=email&utm_source=Eloqua&elqTrackId=46103bdc375c411a979c2f658fc99074&elq=7026706360154fee9b6d588b27d8eb6a&elqaid=506&elqat=1&elqCampaignId=343)
158
+	 * Once that happens, this will be obsolete and WILL BE REMOVED.
159
+	 *
160
+	 * @param string $url
161
+	 * @param EEG_Aim $gateway_object
162
+	 * @return string
163
+	 */
164
+	public function possibly_use_deprecated_aim_server($url, EEG_Aim $gateway_object)
165
+	{
166
+		if ($gateway_object->_server === 'authorize.net' && ! $gateway_object->_debug_mode) {
167
+			return 'https://secure.authorize.net/gateway/transact.dll';
168
+		} else {
169
+			return $url;
170
+		}
171
+	}
172
+
173
+
174
+	/**
175
+	 * Asks the gateway to do whatever it does to process the payment. Onsite gateways will
176
+	 * usually send a request directly to the payment provider and update the payment's status based on that;
177
+	 * whereas offsite gateways will usually just update the payment with the URL and query parameters to use
178
+	 * for sending the request via http_remote_request()
179
+	 *
180
+	 * @param EEI_Payment $payment
181
+	 * @param array $billing_info {
182
+	 *  @type $credit_card string
183
+	 *  @type $cvv string
184
+	 *  @type $exp_month string
185
+	 *  @type $exp_year string
186
+	 *  @see parent::do_direct_payment
187
+	 * }
188
+	 * @return EEI_Payment updated
189
+	 */
190
+	public function do_direct_payment($payment, $billing_info = null)
191
+	{
192
+		add_filter('FHEE__EEG_Aim___get_server_url', array($this, 'possibly_use_deprecated_aim_server'), 10, 2);
193
+		// Enable test mode if needed
194
+		// 4007000000027  <-- test successful visa
195
+		// 4222222222222  <-- test failure card number
196
+
197
+		$item_num = 1;
198
+		$transaction = $payment->transaction();
199
+		$gateway_formatter = $this->_get_gateway_formatter();
200
+		$order_description = $gateway_formatter->formatOrderDescription($payment);
201
+		$primary_registrant = $transaction->primary_registration();
202
+		// if we're are charging for the full amount, show the normal line items
203
+		// and the itemized total adds up properly
204
+		if ($this->_can_easily_itemize_transaction_for($payment)) {
205
+			$total_line_item = $transaction->total_line_item();
206
+			foreach ($total_line_item->get_items() as $line_item) {
207
+				if ($line_item->quantity() == 0) {
208
+					continue;
209
+				}
210
+				$this->addLineItem(
211
+					$item_num++,
212
+					$gateway_formatter->formatLineItemName($line_item, $payment),
213
+					$gateway_formatter->formatLineItemDesc($line_item, $payment),
214
+					$line_item->quantity(),
215
+					$line_item->unit_price(),
216
+					'N'
217
+				);
218
+				$order_description .= $line_item->desc().', ';
219
+			}
220
+			foreach ($total_line_item->tax_descendants() as $tax_line_item) {
221
+				$this->addLineItem(
222
+					$item_num++,
223
+					$tax_line_item->name(),
224
+					$tax_line_item->desc(),
225
+					1,
226
+					$tax_line_item->total(),
227
+					'N'
228
+				);
229
+			}
230
+		}
231
+
232
+		// start transaction
233
+		// if in debug mode, use authorize.net's sandbox id; otherwise use the Event Espresso partner id
234
+		$partner_id = $this->_debug_mode ? 'AAA100302' : 'AAA105363';
235
+		$this->setField('solution_id', $partner_id);
236
+		$this->setField('amount', $gateway_formatter->formatCurrency($payment->amount()));
237
+		$this->setField('description', substr(rtrim($order_description, ', '), 0, 255));
238
+		$this->_set_sensitive_billing_data($billing_info);
239
+		$this->setField('first_name', $billing_info['first_name']);
240
+		$this->setField('last_name', $billing_info['last_name']);
241
+		$this->setField('email', $billing_info['email']);
242
+		$this->setField('company', $billing_info['company']);
243
+		$this->setField('address', $billing_info['address'].' '.$billing_info['address2']);
244
+		$this->setField('city', $billing_info['city']);
245
+		$this->setField('state', $billing_info['state']);
246
+		$this->setField('country', $billing_info['country']);
247
+		$this->setField('zip', $billing_info['zip']);
248
+		$this->setField('fax', $billing_info['fax']);
249
+		$this->setField('cust_id', $primary_registrant->ID());
250
+		$this->setField('phone', $billing_info['phone']);
251
+		$currency_config = LoaderFactory::getLoader()->load('EE_Currency_Config');
252
+		$this->setField('currency_code', $currency_config->code);
253
+		// invoice_num would be nice to have it be unique per SPCO page-load, that way if users
254
+		// press back, they don't submit a duplicate. However, we may be keeping the user on teh same spco page
255
+		// in which case, we need to generate teh invoice num per request right here...
256
+		$this->setField('invoice_num', wp_generate_password(12, false));// $billing_info['_reg-page-billing-invoice-'.$this->_gateway_name]['value']);
257
+		// tell AIM that any duplicates sent in the next 5 minutes are to be ignored
258
+		$this->setField('duplicate_window', 5 * MINUTE_IN_SECONDS);
259
+
260
+		if ($this->_test_transactions) {
261
+			$this->test_request = "true";
262
+		}
263
+
264
+		// Capture response
265
+		$this->type = "AUTH_CAPTURE";
266
+		$response = $this->_sendRequest($payment);
267
+		if (! empty($response)) {
268
+			if ($response->error_message) {
269
+				$payment->set_status($this->_pay_model->failed_status());
270
+				$payment->set_gateway_response($response->error_message);
271
+			} else {
272
+				$payment_status = $response->approved
273
+					? $this->_pay_model->approved_status()
274
+					: $this->_pay_model->declined_status();
275
+				$payment->set_status($payment_status);
276
+				// make sure we interpret the AMT as a float, not an international string (where periods are thousand separators)
277
+				$payment->set_amount((float) $response->amount);
278
+				$payment->set_gateway_response(
279
+					sprintf(
280
+						esc_html__('%1$s (Reason Code: %2$s)', 'event_espresso'),
281
+						$response->response_reason_text,
282
+						$response->response_reason_code
283
+					)
284
+				);
285
+				if ($this->_debug_mode) {
286
+					$txn_id = $response->invoice_number;
287
+				} else {
288
+					$txn_id = $response->transaction_id;
289
+				}
290
+				$payment->set_txn_id_chq_nmbr($txn_id);
291
+			}
292
+			$payment->set_extra_accntng($primary_registrant->reg_code());
293
+			$payment->set_details(print_r($response, true));
294
+		} else {
295
+			$payment->set_status($this->_pay_model->failed_status());
296
+			$payment->set_gateway_response(__("There was no response from Authorize.net", 'event_espresso'));
297
+			$payment->set_details(print_r($response, true));
298
+		}
299
+		return $payment;
300
+	}
301
+
302
+
303
+	/**
304
+	 * Sets billing data for the upcoming request to AIM that is considered sensitive;
305
+	 * also this method can be overridden by children classes to easily change
306
+	 * what billing data gets sent
307
+	 *
308
+	 * @param array $billing_info
309
+	 */
310
+	protected function _set_sensitive_billing_data($billing_info)
311
+	{
312
+		$this->setField('card_num', $billing_info['credit_card']);
313
+		$this->setField('exp_date', $billing_info['exp_month'] . $billing_info['exp_year']);
314
+		$this->setField('card_code', $billing_info['cvv']);
315
+	}
316
+
317
+
318
+	/**
319
+	 * Add a line item.
320
+	 *
321
+	 * @param string $item_id
322
+	 * @param string $item_name
323
+	 * @param string $item_description
324
+	 * @param string $item_quantity
325
+	 * @param string $item_unit_price
326
+	 * @param string $item_taxable
327
+	 */
328
+	public function addLineItem($item_id, $item_name, $item_description, $item_quantity, $item_unit_price, $item_taxable)
329
+	{
330
+		$args = array(
331
+			substr($item_id, 0, 31),
332
+			substr($item_name, 0, 31),
333
+			substr($item_description, 0, 255),
334
+			number_format(abs($item_quantity), 2, '.', ''),
335
+			number_format(abs($item_unit_price), 2, '.', ''),
336
+			$item_taxable === 'N' ? 'N' : 'Y'
337
+		);
338
+		$this->_additional_line_items[] = implode('<|>', $args);
339
+	}
340
+
341
+
342
+	/**
343
+	 * Set an individual name/value pair. This will append x_ to the name
344
+	 * before posting.
345
+	 *
346
+	 * @param string $name
347
+	 * @param string $value
348
+	 * @throws AuthorizeNetException
349
+	 */
350
+	protected function setField($name, $value)
351
+	{
352
+		if (in_array($name, $this->_all_aim_fields)) {
353
+			$this->_x_post_fields[ $name ] = $value;
354
+		} else {
355
+			throw new AuthorizeNetException("Error: no field $name exists in the AIM API.
356 356
             To set a custom field use setCustomField('field','value') instead.");
357
-        }
358
-    }
359
-
360
-
361
-    /**
362
-     * Posts the request to AuthorizeNet & returns response.
363
-     *
364
-     * @param $payment
365
-     * @return \EE_AuthorizeNetAIM_Response
366
-     */
367
-    private function _sendRequest($payment)
368
-    {
369
-        $this->_x_post_fields['login'] = $this->_login_id;
370
-        $this->_x_post_fields['tran_key'] = $this->_transaction_key;
371
-        $x_keys = array();
372
-        foreach ($this->_x_post_fields as $key => $value) {
373
-            $x_keys[] = "x_$key=" . urlencode($this->_get_unsupported_character_remover()->format($value));
374
-        }
375
-        // Add line items
376
-        foreach ($this->_additional_line_items as $key => $value) {
377
-            $x_keys[] =  "x_line_item=" . urlencode($this->_get_unsupported_character_remover()->format($value));
378
-        }
379
-        $this->_log_clean_request($x_keys, $payment);
380
-        $post_url = $this->_get_server_url();
381
-        $curl_request = curl_init($post_url);
382
-        $post_body = implode("&", $x_keys);
383
-        curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post_body);
384
-        curl_setopt($curl_request, CURLOPT_HEADER, 0);
385
-        curl_setopt($curl_request, CURLOPT_TIMEOUT, 45);
386
-        curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);
387
-        curl_setopt($curl_request, CURLOPT_SSL_VERIFYHOST, 2);
388
-        if ($this->VERIFY_PEER) {
389
-            curl_setopt($curl_request, CURLOPT_CAINFO, dirname(__DIR__) . '/ssl/cert.pem');
390
-        } else {
391
-            curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, false);
392
-        }
393
-
394
-        if (preg_match('/xml/', $post_url)) {
395
-            curl_setopt($curl_request, CURLOPT_HTTPHEADER, array("Content-Type: text/xml"));
396
-        }
397
-
398
-        $response = curl_exec($curl_request);
399
-
400
-        curl_close($curl_request);
401
-        $response_obj =  new EE_AuthorizeNetAIM_Response($response);
402
-
403
-        return $this->_log_and_clean_response($response_obj, $payment);
404
-    }
405
-
406
-
407
-    /**
408
-     * Logs the clean data only
409
-     *
410
-     * @param array $request_array
411
-     * @param EEI_Payment $payment
412
-     */
413
-    protected function _log_clean_request($request_array, $payment)
414
-    {
415
-        $keys_to_filter_out = array('x_card_num', 'x_card_code', 'x_exp_date');
416
-        foreach ($request_array as $index => $keyvaltogether) {
417
-            foreach ($keys_to_filter_out as $key) {
418
-                if (strpos($keyvaltogether, $key) === 0) {
419
-                    // found it at the first character
420
-                    // so its one of them
421
-                    unset($request_array[ $index ]);
422
-                }
423
-            }
424
-        }
425
-        $this->log(
426
-            array(
427
-                'AIM Request sent:' => $request_array,
428
-                'Server URL'        => $this->_get_server_url()
429
-            ),
430
-            $payment
431
-        );
432
-    }
433
-
434
-
435
-
436
-    /**
437
-     * Logs the response and cleans it
438
-     *
439
-     * @param EE_AuthorizeNetAIM_Response $response_obj
440
-     * @param EE_Payment                  $payment
441
-     * @return \EE_AuthorizeNetAIM_Response
442
-     */
443
-    private function _log_and_clean_response($response_obj, $payment)
444
-    {
445
-        $response_obj->account_number = '';
446
-        $this->log(array('AIM Response received:' => (array) $response_obj), $payment);
447
-        return $response_obj;
448
-    }
357
+		}
358
+	}
359
+
360
+
361
+	/**
362
+	 * Posts the request to AuthorizeNet & returns response.
363
+	 *
364
+	 * @param $payment
365
+	 * @return \EE_AuthorizeNetAIM_Response
366
+	 */
367
+	private function _sendRequest($payment)
368
+	{
369
+		$this->_x_post_fields['login'] = $this->_login_id;
370
+		$this->_x_post_fields['tran_key'] = $this->_transaction_key;
371
+		$x_keys = array();
372
+		foreach ($this->_x_post_fields as $key => $value) {
373
+			$x_keys[] = "x_$key=" . urlencode($this->_get_unsupported_character_remover()->format($value));
374
+		}
375
+		// Add line items
376
+		foreach ($this->_additional_line_items as $key => $value) {
377
+			$x_keys[] =  "x_line_item=" . urlencode($this->_get_unsupported_character_remover()->format($value));
378
+		}
379
+		$this->_log_clean_request($x_keys, $payment);
380
+		$post_url = $this->_get_server_url();
381
+		$curl_request = curl_init($post_url);
382
+		$post_body = implode("&", $x_keys);
383
+		curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post_body);
384
+		curl_setopt($curl_request, CURLOPT_HEADER, 0);
385
+		curl_setopt($curl_request, CURLOPT_TIMEOUT, 45);
386
+		curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);
387
+		curl_setopt($curl_request, CURLOPT_SSL_VERIFYHOST, 2);
388
+		if ($this->VERIFY_PEER) {
389
+			curl_setopt($curl_request, CURLOPT_CAINFO, dirname(__DIR__) . '/ssl/cert.pem');
390
+		} else {
391
+			curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, false);
392
+		}
393
+
394
+		if (preg_match('/xml/', $post_url)) {
395
+			curl_setopt($curl_request, CURLOPT_HTTPHEADER, array("Content-Type: text/xml"));
396
+		}
397
+
398
+		$response = curl_exec($curl_request);
399
+
400
+		curl_close($curl_request);
401
+		$response_obj =  new EE_AuthorizeNetAIM_Response($response);
402
+
403
+		return $this->_log_and_clean_response($response_obj, $payment);
404
+	}
405
+
406
+
407
+	/**
408
+	 * Logs the clean data only
409
+	 *
410
+	 * @param array $request_array
411
+	 * @param EEI_Payment $payment
412
+	 */
413
+	protected function _log_clean_request($request_array, $payment)
414
+	{
415
+		$keys_to_filter_out = array('x_card_num', 'x_card_code', 'x_exp_date');
416
+		foreach ($request_array as $index => $keyvaltogether) {
417
+			foreach ($keys_to_filter_out as $key) {
418
+				if (strpos($keyvaltogether, $key) === 0) {
419
+					// found it at the first character
420
+					// so its one of them
421
+					unset($request_array[ $index ]);
422
+				}
423
+			}
424
+		}
425
+		$this->log(
426
+			array(
427
+				'AIM Request sent:' => $request_array,
428
+				'Server URL'        => $this->_get_server_url()
429
+			),
430
+			$payment
431
+		);
432
+	}
433
+
434
+
435
+
436
+	/**
437
+	 * Logs the response and cleans it
438
+	 *
439
+	 * @param EE_AuthorizeNetAIM_Response $response_obj
440
+	 * @param EE_Payment                  $payment
441
+	 * @return \EE_AuthorizeNetAIM_Response
442
+	 */
443
+	private function _log_and_clean_response($response_obj, $payment)
444
+	{
445
+		$response_obj->account_number = '';
446
+		$this->log(array('AIM Response received:' => (array) $response_obj), $payment);
447
+		return $response_obj;
448
+	}
449 449
 }
450 450
 
451 451
 
@@ -461,192 +461,192 @@  discard block
 block discarded – undo
461 461
 class EE_AuthorizeNetAIM_Response
462 462
 {
463 463
 
464
-    const APPROVED = '1';
465
-    const DECLINED = '2';
466
-    const ERROR = '3';
467
-    const HELD = '4';
468
-
469
-    protected $_x_post_fields = array(
470
-        "version"        => "3.1",
471
-        "delim_char"     => ",",
472
-        "delim_data"     => "TRUE",
473
-        "relay_response" => "FALSE",
474
-        "encap_char"     => "|",
475
-    );
476
-    public $approved;
477
-    public $declined;
478
-    public $error;
479
-    public $held;
480
-    public $response_code;
481
-    public $response_subcode;
482
-    public $response_reason_code;
483
-    public $response_reason_text;
484
-    public $authorization_code;
485
-    public $avs_response;
486
-    public $transaction_id;
487
-    public $invoice_number;
488
-    public $description;
489
-    public $amount;
490
-    public $method;
491
-    public $transaction_type;
492
-    public $customer_id;
493
-    public $first_name;
494
-    public $last_name;
495
-    public $company;
496
-    public $address;
497
-    public $city;
498
-    public $state;
499
-    public $zip_code;
500
-    public $country;
501
-    public $phone;
502
-    public $fax;
503
-    public $email_address;
504
-    public $ship_to_first_name;
505
-    public $ship_to_last_name;
506
-    public $ship_to_company;
507
-    public $ship_to_address;
508
-    public $ship_to_city;
509
-    public $ship_to_state;
510
-    public $ship_to_zip_code;
511
-    public $ship_to_country;
512
-    public $tax;
513
-    public $duty;
514
-    public $freight;
515
-    public $tax_exempt;
516
-    public $purchase_order_number;
517
-    public $md5_hash;
518
-    public $card_code_response;
519
-    public $cavv_response; // cardholder_authentication_verification_response
520
-    public $account_number;
521
-    public $card_type;
522
-    public $split_tender_id;
523
-    public $requested_amount;
524
-    public $balance_on_card;
525
-    public $response; // The response string from AuthorizeNet.
526
-    public $error_message;
527
-    private $_response_array = array(); // An array with the split response.
528
-
529
-
530
-    /**
531
-     * Constructor. Parses the AuthorizeNet response string
532
-     *
533
-     * @param string $response The response from the AuthNet server.
534
-     * @var string   $delimiter The delimiter used (default is ",")
535
-     * @var string   $encap_char The encap_char used (default is "|")
536
-     * @var array    $custom_fields Any custom fields set in the request.
537
-     */
538
-
539
-    public function __construct($response)
540
-    {
541
-        $encap_char = $this->_x_post_fields['encap_char'];
542
-        $delimiter = $this->_x_post_fields['delim_char'];
543
-        if ($response) {
544
-            // Split Array
545
-            $this->response = $response;
546
-            if ($encap_char) {
547
-                $this->_response_array = explode($encap_char . $delimiter . $encap_char, substr($response, 1, -1));
548
-            } else {
549
-                $this->_response_array = explode($delimiter, $response);
550
-            }
551
-
552
-            /**
553
-             * If AuthorizeNet doesn't return a delimited response.
554
-             */
555
-            if (count($this->_response_array) < 10) {
556
-                $this->approved = false;
557
-                $this->error = true;
558
-                $this->error_message = sprintf(
559
-                    esc_html__('Unrecognized response from Authorize.net: %1$s', 'event_espresso'),
560
-                    esc_html($response)
561
-                );
562
-                return;
563
-            }
564
-
565
-
566
-
567
-            // Set all fields
568
-            $this->response_code = $this->_response_array[0];
569
-            $this->response_subcode = $this->_response_array[1];
570
-            $this->response_reason_code = $this->_response_array[2];
571
-            $this->response_reason_text = $this->_response_array[3];
572
-            $this->authorization_code = $this->_response_array[4];
573
-            $this->avs_response = $this->_response_array[5];
574
-            $this->transaction_id = $this->_response_array[6];
575
-            $this->invoice_number = $this->_response_array[7];
576
-            $this->description = $this->_response_array[8];
577
-            $this->amount = $this->_response_array[9];
578
-            $this->method = $this->_response_array[10];
579
-            $this->transaction_type = $this->_response_array[11];
580
-            $this->customer_id = $this->_response_array[12];
581
-            $this->first_name = $this->_response_array[13];
582
-            $this->last_name = $this->_response_array[14];
583
-            $this->company = $this->_response_array[15];
584
-            $this->address = $this->_response_array[16];
585
-            $this->city = $this->_response_array[17];
586
-            $this->state = $this->_response_array[18];
587
-            $this->zip_code = $this->_response_array[19];
588
-            $this->country = $this->_response_array[20];
589
-            $this->phone = $this->_response_array[21];
590
-            $this->fax = $this->_response_array[22];
591
-            $this->email_address = $this->_response_array[23];
592
-            $this->ship_to_first_name = $this->_response_array[24];
593
-            $this->ship_to_last_name = $this->_response_array[25];
594
-            $this->ship_to_company = $this->_response_array[26];
595
-            $this->ship_to_address = $this->_response_array[27];
596
-            $this->ship_to_city = $this->_response_array[28];
597
-            $this->ship_to_state = $this->_response_array[29];
598
-            $this->ship_to_zip_code = $this->_response_array[30];
599
-            $this->ship_to_country = $this->_response_array[31];
600
-            $this->tax = $this->_response_array[32];
601
-            $this->duty = $this->_response_array[33];
602
-            $this->freight = $this->_response_array[34];
603
-            $this->tax_exempt = $this->_response_array[35];
604
-            $this->purchase_order_number = $this->_response_array[36];
605
-            $this->md5_hash = $this->_response_array[37];
606
-            $this->card_code_response = $this->_response_array[38];
607
-            $this->cavv_response = $this->_response_array[39];
608
-            $this->account_number = $this->_response_array[50];
609
-            $this->card_type = $this->_response_array[51];
610
-            $this->split_tender_id = $this->_response_array[52];
611
-            $this->requested_amount = $this->_response_array[53];
612
-            $this->balance_on_card = $this->_response_array[54];
613
-
614
-            $this->approved = ($this->response_code === self::APPROVED);
615
-            $this->declined = ($this->response_code === self::DECLINED);
616
-            $this->error = ($this->response_code === self::ERROR);
617
-            $this->held = ($this->response_code === self::HELD);
618
-        } else {
619
-            $this->approved = false;
620
-            $this->error = true;
621
-            $this->error_message = esc_html__(
622
-                'Error connecting to Authorize.net',
623
-                'event_espresso'
624
-            );
625
-        }
626
-    }
464
+	const APPROVED = '1';
465
+	const DECLINED = '2';
466
+	const ERROR = '3';
467
+	const HELD = '4';
468
+
469
+	protected $_x_post_fields = array(
470
+		"version"        => "3.1",
471
+		"delim_char"     => ",",
472
+		"delim_data"     => "TRUE",
473
+		"relay_response" => "FALSE",
474
+		"encap_char"     => "|",
475
+	);
476
+	public $approved;
477
+	public $declined;
478
+	public $error;
479
+	public $held;
480
+	public $response_code;
481
+	public $response_subcode;
482
+	public $response_reason_code;
483
+	public $response_reason_text;
484
+	public $authorization_code;
485
+	public $avs_response;
486
+	public $transaction_id;
487
+	public $invoice_number;
488
+	public $description;
489
+	public $amount;
490
+	public $method;
491
+	public $transaction_type;
492
+	public $customer_id;
493
+	public $first_name;
494
+	public $last_name;
495
+	public $company;
496
+	public $address;
497
+	public $city;
498
+	public $state;
499
+	public $zip_code;
500
+	public $country;
501
+	public $phone;
502
+	public $fax;
503
+	public $email_address;
504
+	public $ship_to_first_name;
505
+	public $ship_to_last_name;
506
+	public $ship_to_company;
507
+	public $ship_to_address;
508
+	public $ship_to_city;
509
+	public $ship_to_state;
510
+	public $ship_to_zip_code;
511
+	public $ship_to_country;
512
+	public $tax;
513
+	public $duty;
514
+	public $freight;
515
+	public $tax_exempt;
516
+	public $purchase_order_number;
517
+	public $md5_hash;
518
+	public $card_code_response;
519
+	public $cavv_response; // cardholder_authentication_verification_response
520
+	public $account_number;
521
+	public $card_type;
522
+	public $split_tender_id;
523
+	public $requested_amount;
524
+	public $balance_on_card;
525
+	public $response; // The response string from AuthorizeNet.
526
+	public $error_message;
527
+	private $_response_array = array(); // An array with the split response.
528
+
529
+
530
+	/**
531
+	 * Constructor. Parses the AuthorizeNet response string
532
+	 *
533
+	 * @param string $response The response from the AuthNet server.
534
+	 * @var string   $delimiter The delimiter used (default is ",")
535
+	 * @var string   $encap_char The encap_char used (default is "|")
536
+	 * @var array    $custom_fields Any custom fields set in the request.
537
+	 */
538
+
539
+	public function __construct($response)
540
+	{
541
+		$encap_char = $this->_x_post_fields['encap_char'];
542
+		$delimiter = $this->_x_post_fields['delim_char'];
543
+		if ($response) {
544
+			// Split Array
545
+			$this->response = $response;
546
+			if ($encap_char) {
547
+				$this->_response_array = explode($encap_char . $delimiter . $encap_char, substr($response, 1, -1));
548
+			} else {
549
+				$this->_response_array = explode($delimiter, $response);
550
+			}
551
+
552
+			/**
553
+			 * If AuthorizeNet doesn't return a delimited response.
554
+			 */
555
+			if (count($this->_response_array) < 10) {
556
+				$this->approved = false;
557
+				$this->error = true;
558
+				$this->error_message = sprintf(
559
+					esc_html__('Unrecognized response from Authorize.net: %1$s', 'event_espresso'),
560
+					esc_html($response)
561
+				);
562
+				return;
563
+			}
564
+
565
+
566
+
567
+			// Set all fields
568
+			$this->response_code = $this->_response_array[0];
569
+			$this->response_subcode = $this->_response_array[1];
570
+			$this->response_reason_code = $this->_response_array[2];
571
+			$this->response_reason_text = $this->_response_array[3];
572
+			$this->authorization_code = $this->_response_array[4];
573
+			$this->avs_response = $this->_response_array[5];
574
+			$this->transaction_id = $this->_response_array[6];
575
+			$this->invoice_number = $this->_response_array[7];
576
+			$this->description = $this->_response_array[8];
577
+			$this->amount = $this->_response_array[9];
578
+			$this->method = $this->_response_array[10];
579
+			$this->transaction_type = $this->_response_array[11];
580
+			$this->customer_id = $this->_response_array[12];
581
+			$this->first_name = $this->_response_array[13];
582
+			$this->last_name = $this->_response_array[14];
583
+			$this->company = $this->_response_array[15];
584
+			$this->address = $this->_response_array[16];
585
+			$this->city = $this->_response_array[17];
586
+			$this->state = $this->_response_array[18];
587
+			$this->zip_code = $this->_response_array[19];
588
+			$this->country = $this->_response_array[20];
589
+			$this->phone = $this->_response_array[21];
590
+			$this->fax = $this->_response_array[22];
591
+			$this->email_address = $this->_response_array[23];
592
+			$this->ship_to_first_name = $this->_response_array[24];
593
+			$this->ship_to_last_name = $this->_response_array[25];
594
+			$this->ship_to_company = $this->_response_array[26];
595
+			$this->ship_to_address = $this->_response_array[27];
596
+			$this->ship_to_city = $this->_response_array[28];
597
+			$this->ship_to_state = $this->_response_array[29];
598
+			$this->ship_to_zip_code = $this->_response_array[30];
599
+			$this->ship_to_country = $this->_response_array[31];
600
+			$this->tax = $this->_response_array[32];
601
+			$this->duty = $this->_response_array[33];
602
+			$this->freight = $this->_response_array[34];
603
+			$this->tax_exempt = $this->_response_array[35];
604
+			$this->purchase_order_number = $this->_response_array[36];
605
+			$this->md5_hash = $this->_response_array[37];
606
+			$this->card_code_response = $this->_response_array[38];
607
+			$this->cavv_response = $this->_response_array[39];
608
+			$this->account_number = $this->_response_array[50];
609
+			$this->card_type = $this->_response_array[51];
610
+			$this->split_tender_id = $this->_response_array[52];
611
+			$this->requested_amount = $this->_response_array[53];
612
+			$this->balance_on_card = $this->_response_array[54];
613
+
614
+			$this->approved = ($this->response_code === self::APPROVED);
615
+			$this->declined = ($this->response_code === self::DECLINED);
616
+			$this->error = ($this->response_code === self::ERROR);
617
+			$this->held = ($this->response_code === self::HELD);
618
+		} else {
619
+			$this->approved = false;
620
+			$this->error = true;
621
+			$this->error_message = esc_html__(
622
+				'Error connecting to Authorize.net',
623
+				'event_espresso'
624
+			);
625
+		}
626
+	}
627 627
 }
628 628
 
629 629
 if (! class_exists('AuthorizeNetException')) {
630
-    /**
631
-     * Class AuthorizeNetException
632
-     *
633
-     * @package    AuthorizeNet
634
-     */
635
-    class AuthorizeNetException extends Exception
636
-    {
637
-
638
-        /**
639
-         * Construct the exception. Note: The message is NOT binary safe.
640
-         *
641
-         * @link http://php.net/manual/en/exception.construct.php
642
-         * @param string $message [optional] The Exception message to throw.
643
-         * @param int $code [optional] The Exception code.
644
-         * @param Exception $previous [optional] The previous exception used for the exception chaining. Since 5.3.0
645
-         * @since 5.1.0
646
-         */
647
-        public function __construct($message = "", $code = 0, Exception $previous = null)
648
-        {
649
-            parent::__construct($message, $code, $previous);
650
-        }
651
-    }
630
+	/**
631
+	 * Class AuthorizeNetException
632
+	 *
633
+	 * @package    AuthorizeNet
634
+	 */
635
+	class AuthorizeNetException extends Exception
636
+	{
637
+
638
+		/**
639
+		 * Construct the exception. Note: The message is NOT binary safe.
640
+		 *
641
+		 * @link http://php.net/manual/en/exception.construct.php
642
+		 * @param string $message [optional] The Exception message to throw.
643
+		 * @param int $code [optional] The Exception code.
644
+		 * @param Exception $previous [optional] The previous exception used for the exception chaining. Since 5.3.0
645
+		 * @since 5.1.0
646
+		 */
647
+		public function __construct($message = "", $code = 0, Exception $previous = null)
648
+		{
649
+			parent::__construct($message, $code, $previous);
650
+		}
651
+	}
652 652
 }
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.
Indentation   +4484 added lines, -4484 removed lines patch added patch discarded remove patch
@@ -19,2588 +19,2588 @@  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
-            'sent_status'                => array(
1080
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent,
1081
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, 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
-            'failed_status'              => array(
1088
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
1089
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, 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
-            'resend_status'              => array(
1096
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend,
1097
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence'),
1098
-            ),
1099
-            'incomplete_status'          => array(
1100
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
1101
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence'),
1102
-            ),
1103
-            'retry_status'               => array(
1104
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry,
1105
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, 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
-        $this->_set_shortcodes(); // this also sets the _message_template property.
1312
-        $message_template_group = $this->_message_template_group;
1313
-        $c_label = $message_template_group->context_label();
1314
-        $c_config = $message_template_group->contexts_config();
1315
-
1316
-        reset($c_config);
1317
-        $context = isset($this->_req_data['context']) && ! empty($this->_req_data['context'])
1318
-            ? strtolower($this->_req_data['context'])
1319
-            : key($c_config);
1320
-
1321
-
1322
-        if (empty($GRP_ID)) {
1323
-            $action = 'insert_message_template';
1324
-            $edit_message_template_form_url = add_query_arg(
1325
-                array('action' => $action, 'noheader' => true),
1326
-                EE_MSG_ADMIN_URL
1327
-            );
1328
-        } else {
1329
-            $action = 'update_message_template';
1330
-            $edit_message_template_form_url = add_query_arg(
1331
-                array('action' => $action, 'noheader' => true),
1332
-                EE_MSG_ADMIN_URL
1333
-            );
1334
-        }
1335
-
1336
-        // set active messenger for this view
1337
-        $this->_active_messenger = $this->_message_resource_manager->get_active_messenger(
1338
-            $message_template_group->messenger()
1339
-        );
1340
-        $this->_active_message_type_name = $message_template_group->message_type();
1341
-
1342
-
1343
-        // Do we have any validation errors?
1344
-        $validators = $this->_get_transient();
1345
-        $v_fields = ! empty($validators) ? array_keys($validators) : array();
1346
-
1347
-
1348
-        // we need to assemble the title from Various details
1349
-        $context_label = sprintf(
1350
-            esc_html__('(%s %s)', 'event_espresso'),
1351
-            $c_config[ $context ]['label'],
1352
-            ucwords($c_label['label'])
1353
-        );
1354
-
1355
-        $title = sprintf(
1356
-            esc_html__(' %s %s Template %s', 'event_espresso'),
1357
-            ucwords($message_template_group->messenger_obj()->label['singular']),
1358
-            ucwords($message_template_group->message_type_obj()->label['singular']),
1359
-            $context_label
1360
-        );
1361
-
1362
-        $this->_template_args['GRP_ID'] = $GRP_ID;
1363
-        $this->_template_args['message_template'] = $message_template_group;
1364
-        $this->_template_args['is_extra_fields'] = false;
1365
-
1366
-
1367
-        // let's get EEH_MSG_Template so we can get template form fields
1368
-        $template_field_structure = EEH_MSG_Template::get_fields(
1369
-            $message_template_group->messenger(),
1370
-            $message_template_group->message_type()
1371
-        );
1372
-
1373
-        if (! $template_field_structure) {
1374
-            $template_field_structure = false;
1375
-            $template_fields = esc_html__(
1376
-                'There was an error in assembling the fields for this display (you should see an error message)',
1377
-                'event_espresso'
1378
-            );
1379
-        }
1380
-
1381
-
1382
-        $message_templates = $message_template_group->context_templates();
1383
-
1384
-
1385
-        // if we have the extra key.. then we need to remove the content index from the template_field_structure as it
1386
-        // will get handled in the "extra" array.
1387
-        if (is_array($template_field_structure[ $context ]) && isset($template_field_structure[ $context ]['extra'])) {
1388
-            foreach ($template_field_structure[ $context ]['extra'] as $reference_field => $new_fields) {
1389
-                unset($template_field_structure[ $context ][ $reference_field ]);
1390
-            }
1391
-        }
1392
-
1393
-        // let's loop through the template_field_structure and actually assemble the input fields!
1394
-        if (! empty($template_field_structure)) {
1395
-            foreach ($template_field_structure[ $context ] as $template_field => $field_setup_array) {
1396
-                // if this is an 'extra' template field then we need to remove any existing fields that are keyed up in
1397
-                // the extra array and reset them.
1398
-                if ($template_field === 'extra') {
1399
-                    $this->_template_args['is_extra_fields'] = true;
1400
-                    foreach ($field_setup_array as $reference_field => $new_fields_array) {
1401
-                        $message_template = $message_templates[ $context ][ $reference_field ];
1402
-                        $content = $message_template instanceof EE_Message_Template
1403
-                            ? $message_template->get('MTP_content')
1404
-                            : '';
1405
-                        foreach ($new_fields_array as $extra_field => $extra_array) {
1406
-                            // let's verify if we need this extra field via the shortcodes parameter.
1407
-                            $continue = false;
1408
-                            if (isset($extra_array['shortcodes_required'])) {
1409
-                                foreach ((array) $extra_array['shortcodes_required'] as $shortcode) {
1410
-                                    if (! array_key_exists($shortcode, $this->_shortcodes)) {
1411
-                                        $continue = true;
1412
-                                    }
1413
-                                }
1414
-                                if ($continue) {
1415
-                                    continue;
1416
-                                }
1417
-                            }
1418
-
1419
-                            $field_id = $reference_field
1420
-                                        . '-'
1421
-                                        . $extra_field
1422
-                                        . '-content';
1423
-                            $template_form_fields[ $field_id ] = $extra_array;
1424
-                            $template_form_fields[ $field_id ]['name'] = 'MTP_template_fields['
1425
-                                                                         . $reference_field
1426
-                                                                         . '][content]['
1427
-                                                                         . $extra_field . ']';
1428
-                            $css_class = isset($extra_array['css_class'])
1429
-                                ? $extra_array['css_class']
1430
-                                : '';
1431
-
1432
-                            $template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
1433
-                                                                              && in_array($extra_field, $v_fields, true)
1434
-                                                                              &&
1435
-                                                                              (
1436
-                                                                                  is_array($validators[ $extra_field ])
1437
-                                                                                  && isset($validators[ $extra_field ]['msg'])
1438
-                                                                              )
1439
-                                ? 'validate-error ' . $css_class
1440
-                                : $css_class;
1441
-
1442
-                            $template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
1443
-                                                                          && isset($content[ $extra_field ])
1444
-                                ? $content[ $extra_field ]
1445
-                                : '';
1446
-
1447
-                            // do we have a validation error?  if we do then let's use that value instead
1448
-                            $template_form_fields[ $field_id ]['value'] = isset($validators[ $extra_field ])
1449
-                                ? $validators[ $extra_field ]['value']
1450
-                                : $template_form_fields[ $field_id ]['value'];
1451
-
1452
-
1453
-                            $template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
1454
-
1455
-                            // shortcode selector
1456
-                            $field_name_to_use = $extra_field === 'main'
1457
-                                ? 'content'
1458
-                                : $extra_field;
1459
-                            $template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
1460
-                                $field_name_to_use,
1461
-                                $field_id
1462
-                            );
1463
-
1464
-                            if (isset($extra_array['input']) && $extra_array['input'] === 'wp_editor') {
1465
-                                // we want to decode the entities
1466
-                                $template_form_fields[ $field_id ]['value'] = $template_form_fields[ $field_id ]['value'];
1467
-                            }/**/
1468
-                        }
1469
-                        $templatefield_MTP_id = $reference_field . '-MTP_ID';
1470
-                        $templatefield_templatename_id = $reference_field . '-name';
1471
-
1472
-                        $template_form_fields[ $templatefield_MTP_id ] = array(
1473
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
1474
-                            'label'      => null,
1475
-                            'input'      => 'hidden',
1476
-                            'type'       => 'int',
1477
-                            'required'   => false,
1478
-                            'validation' => false,
1479
-                            'value'      => ! empty($message_templates) ? $message_template->ID() : '',
1480
-                            'css_class'  => '',
1481
-                            'format'     => '%d',
1482
-                            'db-col'     => 'MTP_ID',
1483
-                        );
1484
-
1485
-                        $template_form_fields[ $templatefield_templatename_id ] = array(
1486
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
1487
-                            'label'      => null,
1488
-                            'input'      => 'hidden',
1489
-                            'type'       => 'string',
1490
-                            'required'   => false,
1491
-                            'validation' => true,
1492
-                            'value'      => $reference_field,
1493
-                            'css_class'  => '',
1494
-                            'format'     => '%s',
1495
-                            'db-col'     => 'MTP_template_field',
1496
-                        );
1497
-                    }
1498
-                    continue; // skip the next stuff, we got the necessary fields here for this dataset.
1499
-                } else {
1500
-                    $field_id = $template_field . '-content';
1501
-                    $template_form_fields[ $field_id ] = $field_setup_array;
1502
-                    $template_form_fields[ $field_id ]['name'] = 'MTP_template_fields[' . $template_field . '][content]';
1503
-                    $message_template = isset($message_templates[ $context ][ $template_field ])
1504
-                        ? $message_templates[ $context ][ $template_field ]
1505
-                        : null;
1506
-                    $template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
1507
-                                                                  && is_array($message_templates[ $context ])
1508
-                                                                  && $message_template instanceof EE_Message_Template
1509
-                        ? $message_template->get('MTP_content')
1510
-                        : '';
1511
-
1512
-                    // do we have a validator error for this field?  if we do then we'll use that value instead
1513
-                    $template_form_fields[ $field_id ]['value'] = isset($validators[ $template_field ])
1514
-                        ? $validators[ $template_field ]['value']
1515
-                        : $template_form_fields[ $field_id ]['value'];
1516
-
1517
-
1518
-                    $template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
1519
-                    $css_class = isset($field_setup_array['css_class'])
1520
-                        ? $field_setup_array['css_class']
1521
-                        : '';
1522
-                    $template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
1523
-                                                                      && in_array($template_field, $v_fields, true)
1524
-                                                                      && isset($validators[ $template_field ]['msg'])
1525
-                        ? 'validate-error ' . $css_class
1526
-                        : $css_class;
1527
-
1528
-                    // shortcode selector
1529
-                    $template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
1530
-                        $template_field,
1531
-                        $field_id
1532
-                    );
1533
-                }
1534
-
1535
-                // k took care of content field(s) now let's take care of others.
1536
-
1537
-                $templatefield_MTP_id = $template_field . '-MTP_ID';
1538
-                $templatefield_field_templatename_id = $template_field . '-name';
1539
-
1540
-                // foreach template field there are actually two form fields created
1541
-                $template_form_fields[ $templatefield_MTP_id ] = array(
1542
-                    'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
1543
-                    'label'      => null,
1544
-                    'input'      => 'hidden',
1545
-                    'type'       => 'int',
1546
-                    'required'   => false,
1547
-                    'validation' => true,
1548
-                    'value'      => $message_template instanceof EE_Message_Template ? $message_template->ID() : '',
1549
-                    'css_class'  => '',
1550
-                    'format'     => '%d',
1551
-                    'db-col'     => 'MTP_ID',
1552
-                );
1553
-
1554
-                $template_form_fields[ $templatefield_field_templatename_id ] = array(
1555
-                    'name'       => 'MTP_template_fields[' . $template_field . '][name]',
1556
-                    'label'      => null,
1557
-                    'input'      => 'hidden',
1558
-                    'type'       => 'string',
1559
-                    'required'   => false,
1560
-                    'validation' => true,
1561
-                    'value'      => $template_field,
1562
-                    'css_class'  => '',
1563
-                    'format'     => '%s',
1564
-                    'db-col'     => 'MTP_template_field',
1565
-                );
1566
-            }
1567
-
1568
-            // add other fields
1569
-            $template_form_fields['ee-msg-current-context'] = array(
1570
-                'name'       => 'MTP_context',
1571
-                'label'      => null,
1572
-                'input'      => 'hidden',
1573
-                'type'       => 'string',
1574
-                'required'   => false,
1575
-                'validation' => true,
1576
-                'value'      => $context,
1577
-                'css_class'  => '',
1578
-                'format'     => '%s',
1579
-                'db-col'     => 'MTP_context',
1580
-            );
1581
-
1582
-            $template_form_fields['ee-msg-grp-id'] = array(
1583
-                'name'       => 'GRP_ID',
1584
-                'label'      => null,
1585
-                'input'      => 'hidden',
1586
-                'type'       => 'int',
1587
-                'required'   => false,
1588
-                'validation' => true,
1589
-                'value'      => $GRP_ID,
1590
-                'css_class'  => '',
1591
-                'format'     => '%d',
1592
-                'db-col'     => 'GRP_ID',
1593
-            );
1594
-
1595
-            $template_form_fields['ee-msg-messenger'] = array(
1596
-                'name'       => 'MTP_messenger',
1597
-                'label'      => null,
1598
-                'input'      => 'hidden',
1599
-                'type'       => 'string',
1600
-                'required'   => false,
1601
-                'validation' => true,
1602
-                'value'      => $message_template_group->messenger(),
1603
-                'css_class'  => '',
1604
-                'format'     => '%s',
1605
-                'db-col'     => 'MTP_messenger',
1606
-            );
1607
-
1608
-            $template_form_fields['ee-msg-message-type'] = array(
1609
-                'name'       => 'MTP_message_type',
1610
-                'label'      => null,
1611
-                'input'      => 'hidden',
1612
-                'type'       => 'string',
1613
-                'required'   => false,
1614
-                'validation' => true,
1615
-                'value'      => $message_template_group->message_type(),
1616
-                'css_class'  => '',
1617
-                'format'     => '%s',
1618
-                'db-col'     => 'MTP_message_type',
1619
-            );
1620
-
1621
-            $sidebar_form_fields['ee-msg-is-global'] = array(
1622
-                'name'       => 'MTP_is_global',
1623
-                'label'      => esc_html__('Global Template', 'event_espresso'),
1624
-                'input'      => 'hidden',
1625
-                'type'       => 'int',
1626
-                'required'   => false,
1627
-                'validation' => true,
1628
-                'value'      => $message_template_group->get('MTP_is_global'),
1629
-                'css_class'  => '',
1630
-                'format'     => '%d',
1631
-                'db-col'     => 'MTP_is_global',
1632
-            );
1633
-
1634
-            $sidebar_form_fields['ee-msg-is-override'] = array(
1635
-                'name'       => 'MTP_is_override',
1636
-                'label'      => esc_html__('Override all custom', 'event_espresso'),
1637
-                'input'      => $message_template_group->is_global() ? 'checkbox' : 'hidden',
1638
-                'type'       => 'int',
1639
-                'required'   => false,
1640
-                'validation' => true,
1641
-                'value'      => $message_template_group->get('MTP_is_override'),
1642
-                'css_class'  => '',
1643
-                'format'     => '%d',
1644
-                'db-col'     => 'MTP_is_override',
1645
-            );
1646
-
1647
-            $sidebar_form_fields['ee-msg-is-active'] = array(
1648
-                'name'       => 'MTP_is_active',
1649
-                'label'      => esc_html__('Active Template', 'event_espresso'),
1650
-                'input'      => 'hidden',
1651
-                'type'       => 'int',
1652
-                'required'   => false,
1653
-                'validation' => true,
1654
-                'value'      => $message_template_group->is_active(),
1655
-                'css_class'  => '',
1656
-                'format'     => '%d',
1657
-                'db-col'     => 'MTP_is_active',
1658
-            );
1659
-
1660
-            $sidebar_form_fields['ee-msg-deleted'] = array(
1661
-                'name'       => 'MTP_deleted',
1662
-                'label'      => null,
1663
-                'input'      => 'hidden',
1664
-                'type'       => 'int',
1665
-                'required'   => false,
1666
-                'validation' => true,
1667
-                'value'      => $message_template_group->get('MTP_deleted'),
1668
-                'css_class'  => '',
1669
-                'format'     => '%d',
1670
-                'db-col'     => 'MTP_deleted',
1671
-            );
1672
-            $sidebar_form_fields['ee-msg-author'] = array(
1673
-                'name'       => 'MTP_user_id',
1674
-                'label'      => esc_html__('Author', 'event_espresso'),
1675
-                'input'      => 'hidden',
1676
-                'type'       => 'int',
1677
-                'required'   => false,
1678
-                'validation' => false,
1679
-                'value'      => $message_template_group->user(),
1680
-                'format'     => '%d',
1681
-                'db-col'     => 'MTP_user_id',
1682
-            );
1683
-
1684
-            $sidebar_form_fields['ee-msg-route'] = array(
1685
-                'name'  => 'action',
1686
-                'input' => 'hidden',
1687
-                'type'  => 'string',
1688
-                'value' => $action,
1689
-            );
1690
-
1691
-            $sidebar_form_fields['ee-msg-id'] = array(
1692
-                'name'  => 'id',
1693
-                'input' => 'hidden',
1694
-                'type'  => 'int',
1695
-                'value' => $GRP_ID,
1696
-            );
1697
-            $sidebar_form_fields['ee-msg-evt-nonce'] = array(
1698
-                'name'  => $action . '_nonce',
1699
-                'input' => 'hidden',
1700
-                'type'  => 'string',
1701
-                'value' => wp_create_nonce($action . '_nonce'),
1702
-            );
1703
-
1704
-            if (isset($this->_req_data['template_switch']) && $this->_req_data['template_switch']) {
1705
-                $sidebar_form_fields['ee-msg-template-switch'] = array(
1706
-                    'name'  => 'template_switch',
1707
-                    'input' => 'hidden',
1708
-                    'type'  => 'int',
1709
-                    'value' => 1,
1710
-                );
1711
-            }
1712
-
1713
-
1714
-            $template_fields = $this->_generate_admin_form_fields($template_form_fields);
1715
-            $sidebar_fields = $this->_generate_admin_form_fields($sidebar_form_fields);
1716
-        } //end if ( !empty($template_field_structure) )
1717
-
1718
-        // set extra content for publish box
1719
-        $this->_template_args['publish_box_extra_content'] = $sidebar_fields;
1720
-        $this->_set_publish_post_box_vars(
1721
-            'id',
1722
-            $GRP_ID,
1723
-            false,
1724
-            add_query_arg(
1725
-                array('action' => 'global_mtps'),
1726
-                $this->_admin_base_url
1727
-            )
1728
-        );
1729
-
1730
-        // add preview button
1731
-        $preview_url = parent::add_query_args_and_nonce(
1732
-            array(
1733
-                'message_type' => $message_template_group->message_type(),
1734
-                'messenger'    => $message_template_group->messenger(),
1735
-                'context'      => $context,
1736
-                'GRP_ID'       => $GRP_ID,
1737
-                'action'       => 'preview_message',
1738
-            ),
1739
-            $this->_admin_base_url
1740
-        );
1741
-        $preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">'
1742
-                          . esc_html__('Preview', 'event_espresso')
1743
-                          . '</a>';
1744
-
1745
-
1746
-        // setup context switcher
1747
-        $context_switcher_args = array(
1748
-            'page'    => 'espresso_messages',
1749
-            'action'  => 'edit_message_template',
1750
-            'id'      => $GRP_ID,
1751
-            'context' => $context,
1752
-            'extra'   => $preview_button,
1753
-        );
1754
-        $this->_set_context_switcher($message_template_group, $context_switcher_args);
1755
-
1756
-
1757
-        // main box
1758
-        $this->_template_args['template_fields'] = $template_fields;
1759
-        $this->_template_args['sidebar_box_id'] = 'details';
1760
-        $this->_template_args['action'] = $action;
1761
-        $this->_template_args['context'] = $context;
1762
-        $this->_template_args['edit_message_template_form_url'] = $edit_message_template_form_url;
1763
-        $this->_template_args['learn_more_about_message_templates_link'] =
1764
-            $this->_learn_more_about_message_templates_link();
1765
-
1766
-
1767
-        $this->_template_args['before_admin_page_content'] = $this->add_context_switcher();
1768
-        $this->_template_args['before_admin_page_content'] .= $this->add_active_context_element(
1769
-            $message_template_group,
1770
-            $context,
1771
-            $context_label
1772
-        );
1773
-        $this->_template_args['before_admin_page_content'] .= $this->_add_form_element_before();
1774
-        $this->_template_args['after_admin_page_content'] = $this->_add_form_element_after();
1775
-
1776
-        $this->_template_path = $this->_template_args['GRP_ID']
1777
-            ? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
1778
-            : EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
1779
-
1780
-        // send along EE_Message_Template_Group object for further template use.
1781
-        $this->_template_args['MTP'] = $message_template_group;
1782
-
1783
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
1784
-            $this->_template_path,
1785
-            $this->_template_args,
1786
-            true
1787
-        );
1788
-
1789
-
1790
-        // finally, let's set the admin_page title
1791
-        $this->_admin_page_title = sprintf(__('Editing %s', 'event_espresso'), $title);
1792
-
1793
-
1794
-        // we need to take care of setting the shortcodes property for use elsewhere.
1795
-        $this->_set_shortcodes();
1796
-
1797
-
1798
-        // final template wrapper
1799
-        $this->display_admin_page_with_sidebar();
1800
-    }
1801
-
1802
-
1803
-    public function filter_tinymce_init($mceInit, $editor_id)
1804
-    {
1805
-        return $mceInit;
1806
-    }
1807
-
1808
-
1809
-    public function add_context_switcher()
1810
-    {
1811
-        return $this->_context_switcher;
1812
-    }
1813
-
1814
-
1815
-    /**
1816
-     * Adds the activation/deactivation toggle for the message template context.
1817
-     *
1818
-     * @param EE_Message_Template_Group $message_template_group
1819
-     * @param string                    $context
1820
-     * @param string                    $context_label
1821
-     * @return string
1822
-     * @throws DomainException
1823
-     * @throws EE_Error
1824
-     * @throws InvalidIdentifierException
1825
-     */
1826
-    protected function add_active_context_element(
1827
-        EE_Message_Template_Group $message_template_group,
1828
-        $context,
1829
-        $context_label
1830
-    ) {
1831
-        $template_args = array(
1832
-            'context'                   => $context,
1833
-            'nonce'                     => wp_create_nonce('activate_' . $context . '_toggle_nonce'),
1834
-            'is_active'                 => $message_template_group->is_context_active($context),
1835
-            'on_off_action'             => $message_template_group->is_context_active($context)
1836
-                ? 'context-off'
1837
-                : 'context-on',
1838
-            'context_label'             => str_replace(array('(', ')'), '', $context_label),
1839
-            'message_template_group_id' => $message_template_group->ID(),
1840
-        );
1841
-        return EEH_Template::display_template(
1842
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_editor_active_context_element.template.php',
1843
-            $template_args,
1844
-            true
1845
-        );
1846
-    }
1847
-
1848
-
1849
-    /**
1850
-     * Ajax callback for `toggle_context_template` ajax action.
1851
-     * Handles toggling the message context on or off.
1852
-     *
1853
-     * @throws EE_Error
1854
-     * @throws InvalidArgumentException
1855
-     * @throws InvalidDataTypeException
1856
-     * @throws InvalidIdentifierException
1857
-     * @throws InvalidInterfaceException
1858
-     */
1859
-    public function toggle_context_template()
1860
-    {
1861
-        $success = true;
1862
-        // check for required data
1863
-        if (! isset(
1864
-            $this->_req_data['message_template_group_id'],
1865
-            $this->_req_data['context'],
1866
-            $this->_req_data['status']
1867
-        )) {
1868
-            EE_Error::add_error(
1869
-                esc_html__('Required data for doing this action is not available.', 'event_espresso'),
1870
-                __FILE__,
1871
-                __FUNCTION__,
1872
-                __LINE__
1873
-            );
1874
-            $success = false;
1875
-        }
1876
-
1877
-        $nonce = isset($this->_req_data['toggle_context_nonce'])
1878
-            ? sanitize_text_field($this->_req_data['toggle_context_nonce'])
1879
-            : '';
1880
-        $nonce_ref = 'activate_' . $this->_req_data['context'] . '_toggle_nonce';
1881
-        $this->_verify_nonce($nonce, $nonce_ref);
1882
-        $status = $this->_req_data['status'];
1883
-        if ($status !== 'off' && $status !== 'on') {
1884
-            EE_Error::add_error(
1885
-                sprintf(
1886
-                    esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
1887
-                    $this->_req_data['status']
1888
-                ),
1889
-                __FILE__,
1890
-                __FUNCTION__,
1891
-                __LINE__
1892
-            );
1893
-            $success = false;
1894
-        }
1895
-        $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID(
1896
-            $this->_req_data['message_template_group_id']
1897
-        );
1898
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
1899
-            EE_Error::add_error(
1900
-                sprintf(
1901
-                    esc_html__(
1902
-                        'Unable to change the active state because the given id "%1$d" does not match a valid "%2$s"',
1903
-                        'event_espresso'
1904
-                    ),
1905
-                    $this->_req_data['message_template_group_id'],
1906
-                    'EE_Message_Template_Group'
1907
-                ),
1908
-                __FILE__,
1909
-                __FUNCTION__,
1910
-                __LINE__
1911
-            );
1912
-            $success = false;
1913
-        }
1914
-        if ($success) {
1915
-            $success = $status === 'off'
1916
-                ? $message_template_group->deactivate_context($this->_req_data['context'])
1917
-                : $message_template_group->activate_context($this->_req_data['context']);
1918
-        }
1919
-        $this->_template_args['success'] = $success;
1920
-        $this->_return_json();
1921
-    }
1922
-
1923
-
1924
-    public function _add_form_element_before()
1925
-    {
1926
-        return '<form method="post" action="'
1927
-               . $this->_template_args["edit_message_template_form_url"]
1928
-               . '" id="ee-msg-edit-frm">';
1929
-    }
1930
-
1931
-    public function _add_form_element_after()
1932
-    {
1933
-        return '</form>';
1934
-    }
1935
-
1936
-
1937
-    /**
1938
-     * This executes switching the template pack for a message template.
1939
-     *
1940
-     * @since 4.5.0
1941
-     * @throws EE_Error
1942
-     * @throws InvalidDataTypeException
1943
-     * @throws InvalidInterfaceException
1944
-     * @throws InvalidArgumentException
1945
-     * @throws ReflectionException
1946
-     */
1947
-    public function switch_template_pack()
1948
-    {
1949
-        $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
1950
-        $template_pack = ! empty($this->_req_data['template_pack']) ? $this->_req_data['template_pack'] : '';
1951
-
1952
-        // verify we have needed values.
1953
-        if (empty($GRP_ID) || empty($template_pack)) {
1954
-            $this->_template_args['error'] = true;
1955
-            EE_Error::add_error(
1956
-                esc_html__('The required date for switching templates is not available.', 'event_espresso'),
1957
-                __FILE__,
1958
-                __FUNCTION__,
1959
-                __LINE__
1960
-            );
1961
-        } else {
1962
-            // get template, set the new template_pack and then reset to default
1963
-            /** @type EE_Message_Template_Group $message_template_group */
1964
-            $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
1965
-
1966
-            $message_template_group->set_template_pack_name($template_pack);
1967
-            $this->_req_data['msgr'] = $message_template_group->messenger();
1968
-            $this->_req_data['mt'] = $message_template_group->message_type();
1969
-
1970
-            $query_args = $this->_reset_to_default_template();
1971
-
1972
-            if (empty($query_args['id'])) {
1973
-                EE_Error::add_error(
1974
-                    esc_html__(
1975
-                        'Something went wrong with switching the template pack. Please try again or contact EE support',
1976
-                        'event_espresso'
1977
-                    ),
1978
-                    __FILE__,
1979
-                    __FUNCTION__,
1980
-                    __LINE__
1981
-                );
1982
-                $this->_template_args['error'] = true;
1983
-            } else {
1984
-                $template_label = $message_template_group->get_template_pack()->label;
1985
-                $template_pack_labels = $message_template_group->messenger_obj()->get_supports_labels();
1986
-                EE_Error::add_success(
1987
-                    sprintf(
1988
-                        esc_html__(
1989
-                            'This message template has been successfully switched to use the %1$s %2$s.  Please wait while the page reloads with your new template.',
1990
-                            'event_espresso'
1991
-                        ),
1992
-                        $template_label,
1993
-                        $template_pack_labels->template_pack
1994
-                    )
1995
-                );
1996
-                // generate the redirect url for js.
1997
-                $url = self::add_query_args_and_nonce(
1998
-                    $query_args,
1999
-                    $this->_admin_base_url
2000
-                );
2001
-                $this->_template_args['data']['redirect_url'] = $url;
2002
-                $this->_template_args['success'] = true;
2003
-            }
2004
-
2005
-            $this->_return_json();
2006
-        }
2007
-    }
2008
-
2009
-
2010
-    /**
2011
-     * This handles resetting the template for the given messenger/message_type so that users can start from scratch if
2012
-     * they want.
2013
-     *
2014
-     * @access protected
2015
-     * @return array|null
2016
-     * @throws EE_Error
2017
-     * @throws InvalidArgumentException
2018
-     * @throws InvalidDataTypeException
2019
-     * @throws InvalidInterfaceException
2020
-     */
2021
-    protected function _reset_to_default_template()
2022
-    {
2023
-
2024
-        $templates = array();
2025
-        $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
2026
-        // we need to make sure we've got the info we need.
2027
-        if (! isset($this->_req_data['msgr'], $this->_req_data['mt'], $this->_req_data['GRP_ID'])) {
2028
-            EE_Error::add_error(
2029
-                esc_html__(
2030
-                    '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.',
2031
-                    'event_espresso'
2032
-                ),
2033
-                __FILE__,
2034
-                __FUNCTION__,
2035
-                __LINE__
2036
-            );
2037
-        }
2038
-
2039
-        // all templates will be reset to whatever the defaults are
2040
-        // for the global template matching the messenger and message type.
2041
-        $success = ! empty($GRP_ID) ? true : false;
2042
-
2043
-        if ($success) {
2044
-            // let's first determine if the incoming template is a global template,
2045
-            // if it isn't then we need to get the global template matching messenger and message type.
2046
-            // $MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID );
2047
-
2048
-
2049
-            // note this is ONLY deleting the template fields (Message Template rows) NOT the message template group.
2050
-            $success = $this->_delete_mtp_permanently($GRP_ID, false);
2051
-
2052
-            if ($success) {
2053
-                // if successfully deleted, lets generate the new ones.
2054
-                // Note. We set GLOBAL to true, because resets on ANY template
2055
-                // will use the related global template defaults for regeneration.
2056
-                // This means that if a custom template is reset it resets to whatever the related global template is.
2057
-                // HOWEVER, we DO keep the template pack and template variation set
2058
-                // for the current custom template when resetting.
2059
-                $templates = $this->_generate_new_templates(
2060
-                    $this->_req_data['msgr'],
2061
-                    $this->_req_data['mt'],
2062
-                    $GRP_ID,
2063
-                    true
2064
-                );
2065
-            }
2066
-        }
2067
-
2068
-        // any error messages?
2069
-        if (! $success) {
2070
-            EE_Error::add_error(
2071
-                esc_html__(
2072
-                    'Something went wrong with deleting existing templates. Unable to reset to default',
2073
-                    'event_espresso'
2074
-                ),
2075
-                __FILE__,
2076
-                __FUNCTION__,
2077
-                __LINE__
2078
-            );
2079
-        }
2080
-
2081
-        // all good, let's add a success message!
2082
-        if ($success && ! empty($templates)) {
2083
-            // the info for the template we generated is the first element in the returned array
2084
-            // $templates = $templates[0];
2085
-            EE_Error::overwrite_success();
2086
-            EE_Error::add_success(__('Templates have been reset to defaults.', 'event_espresso'));
2087
-        }
2088
-
2089
-
2090
-        $query_args = array(
2091
-            'id'      => isset($templates['GRP_ID']) ? $templates['GRP_ID'] : null,
2092
-            'context' => isset($templates['MTP_context']) ? $templates['MTP_context'] : null,
2093
-            'action'  => isset($templates['GRP_ID']) ? 'edit_message_template' : 'global_mtps',
2094
-        );
2095
-
2096
-        // if called via ajax then we return query args otherwise redirect
2097
-        if (defined('DOING_AJAX') && DOING_AJAX) {
2098
-            return $query_args;
2099
-        } else {
2100
-            $this->_redirect_after_action(false, '', '', $query_args, true);
2101
-
2102
-            return null;
2103
-        }
2104
-    }
2105
-
2106
-
2107
-    /**
2108
-     * Retrieve and set the message preview for display.
2109
-     *
2110
-     * @param bool $send if TRUE then we are doing an actual TEST send with the results of the preview.
2111
-     * @return string
2112
-     * @throws ReflectionException
2113
-     * @throws EE_Error
2114
-     * @throws InvalidArgumentException
2115
-     * @throws InvalidDataTypeException
2116
-     * @throws InvalidInterfaceException
2117
-     */
2118
-    public function _preview_message($send = false)
2119
-    {
2120
-        // first make sure we've got the necessary parameters
2121
-        if (! isset(
2122
-            $this->_req_data['message_type'],
2123
-            $this->_req_data['messenger'],
2124
-            $this->_req_data['messenger'],
2125
-            $this->_req_data['GRP_ID']
2126
-        )) {
2127
-            EE_Error::add_error(
2128
-                esc_html__('Missing necessary parameters for displaying preview', 'event_espresso'),
2129
-                __FILE__,
2130
-                __FUNCTION__,
2131
-                __LINE__
2132
-            );
2133
-        }
2134
-
2135
-        EE_Registry::instance()->REQ->set('GRP_ID', $this->_req_data['GRP_ID']);
2136
-
2137
-
2138
-        // get the preview!
2139
-        $preview = EED_Messages::preview_message(
2140
-            $this->_req_data['message_type'],
2141
-            $this->_req_data['context'],
2142
-            $this->_req_data['messenger'],
2143
-            $send
2144
-        );
2145
-
2146
-        if ($send) {
2147
-            return $preview;
2148
-        }
2149
-
2150
-        // let's add a button to go back to the edit view
2151
-        $query_args = array(
2152
-            'id'      => $this->_req_data['GRP_ID'],
2153
-            'context' => $this->_req_data['context'],
2154
-            'action'  => 'edit_message_template',
2155
-        );
2156
-        $go_back_url = parent::add_query_args_and_nonce($query_args, $this->_admin_base_url);
2157
-        $preview_button = '<a href="'
2158
-                          . $go_back_url
2159
-                          . '" class="button-secondary messages-preview-go-back-button">'
2160
-                          . esc_html__('Go Back to Edit', 'event_espresso')
2161
-                          . '</a>';
2162
-        $message_types = $this->get_installed_message_types();
2163
-        $active_messenger = $this->_message_resource_manager->get_active_messenger(
2164
-            $this->_req_data['messenger']
2165
-        );
2166
-        $active_messenger_label = $active_messenger instanceof EE_messenger
2167
-            ? ucwords($active_messenger->label['singular'])
2168
-            : esc_html__('Unknown Messenger', 'event_espresso');
2169
-        // let's provide a helpful title for context
2170
-        $preview_title = sprintf(
2171
-            esc_html__('Viewing Preview for %s %s Message Template', 'event_espresso'),
2172
-            $active_messenger_label,
2173
-            ucwords($message_types[ $this->_req_data['message_type'] ]->label['singular'])
2174
-        );
2175
-        // setup display of preview.
2176
-        $this->_admin_page_title = $preview_title;
2177
-        $this->_template_args['admin_page_content'] = $preview_button . '<br />' . $preview;
2178
-        $this->_template_args['data']['force_json'] = true;
2179
-
2180
-        return '';
2181
-    }
2182
-
2183
-
2184
-    /**
2185
-     * The initial _preview_message is on a no headers route.  It will optionally call this if necessary otherwise it
2186
-     * gets called automatically.
2187
-     *
2188
-     * @since 4.5.0
2189
-     *
2190
-     * @return string
2191
-     */
2192
-    protected function _display_preview_message()
2193
-    {
2194
-        $this->display_admin_page_with_no_sidebar();
2195
-    }
2196
-
2197
-
2198
-    /**
2199
-     * registers metaboxes that should show up on the "edit_message_template" page
2200
-     *
2201
-     * @access protected
2202
-     * @return void
2203
-     */
2204
-    protected function _register_edit_meta_boxes()
2205
-    {
2206
-        add_meta_box(
2207
-            'mtp_valid_shortcodes',
2208
-            esc_html__('Valid Shortcodes', 'event_espresso'),
2209
-            array($this, 'shortcode_meta_box'),
2210
-            $this->_current_screen->id,
2211
-            'side',
2212
-            'default'
2213
-        );
2214
-        add_meta_box(
2215
-            'mtp_extra_actions',
2216
-            esc_html__('Extra Actions', 'event_espresso'),
2217
-            array($this, 'extra_actions_meta_box'),
2218
-            $this->_current_screen->id,
2219
-            'side',
2220
-            'high'
2221
-        );
2222
-        add_meta_box(
2223
-            'mtp_templates',
2224
-            esc_html__('Template Styles', 'event_espresso'),
2225
-            array($this, 'template_pack_meta_box'),
2226
-            $this->_current_screen->id,
2227
-            'side',
2228
-            'high'
2229
-        );
2230
-    }
2231
-
2232
-
2233
-    /**
2234
-     * metabox content for all template pack and variation selection.
2235
-     *
2236
-     * @since 4.5.0
2237
-     * @return string
2238
-     * @throws DomainException
2239
-     * @throws EE_Error
2240
-     * @throws InvalidArgumentException
2241
-     * @throws ReflectionException
2242
-     * @throws InvalidDataTypeException
2243
-     * @throws InvalidInterfaceException
2244
-     */
2245
-    public function template_pack_meta_box()
2246
-    {
2247
-        $this->_set_message_template_group();
2248
-
2249
-        $tp_collection = EEH_MSG_Template::get_template_pack_collection();
2250
-
2251
-        $tp_select_values = array();
2252
-
2253
-        foreach ($tp_collection as $tp) {
2254
-            // only include template packs that support this messenger and message type!
2255
-            $supports = $tp->get_supports();
2256
-            if (! isset($supports[ $this->_message_template_group->messenger() ])
2257
-                || ! in_array(
2258
-                    $this->_message_template_group->message_type(),
2259
-                    $supports[ $this->_message_template_group->messenger() ],
2260
-                    true
2261
-                )
2262
-            ) {
2263
-                // not supported
2264
-                continue;
2265
-            }
2266
-
2267
-            $tp_select_values[] = array(
2268
-                'text' => $tp->label,
2269
-                'id'   => $tp->dbref,
2270
-            );
2271
-        }
2272
-
2273
-        // if empty $tp_select_values then we make sure default is set because EVERY message type should be supported by
2274
-        // the default template pack.  This still allows for the odd template pack to override.
2275
-        if (empty($tp_select_values)) {
2276
-            $tp_select_values[] = array(
2277
-                'text' => esc_html__('Default', 'event_espresso'),
2278
-                'id'   => 'default',
2279
-            );
2280
-        }
2281
-
2282
-        // setup variation select values for the currently selected template.
2283
-        $variations = $this->_message_template_group->get_template_pack()->get_variations(
2284
-            $this->_message_template_group->messenger(),
2285
-            $this->_message_template_group->message_type()
2286
-        );
2287
-        $variations_select_values = array();
2288
-        foreach ($variations as $variation => $label) {
2289
-            $variations_select_values[] = array(
2290
-                'text' => $label,
2291
-                'id'   => $variation,
2292
-            );
2293
-        }
2294
-
2295
-        $template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels();
2296
-
2297
-        $template_args['template_packs_selector'] = EEH_Form_Fields::select_input(
2298
-            'MTP_template_pack',
2299
-            $tp_select_values,
2300
-            $this->_message_template_group->get_template_pack_name()
2301
-        );
2302
-        $template_args['variations_selector'] = EEH_Form_Fields::select_input(
2303
-            'MTP_template_variation',
2304
-            $variations_select_values,
2305
-            $this->_message_template_group->get_template_pack_variation()
2306
-        );
2307
-        $template_args['template_pack_label'] = $template_pack_labels->template_pack;
2308
-        $template_args['template_variation_label'] = $template_pack_labels->template_variation;
2309
-        $template_args['template_pack_description'] = $template_pack_labels->template_pack_description;
2310
-        $template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
2311
-
2312
-        $template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
2313
-
2314
-        EEH_Template::display_template($template, $template_args);
2315
-    }
2316
-
2317
-
2318
-    /**
2319
-     * This meta box holds any extra actions related to Message Templates
2320
-     * For now, this includes Resetting templates to defaults and sending a test email.
2321
-     *
2322
-     * @access  public
2323
-     * @return void
2324
-     * @throws EE_Error
2325
-     */
2326
-    public function extra_actions_meta_box()
2327
-    {
2328
-        $template_form_fields = array();
2329
-
2330
-        $extra_args = array(
2331
-            'msgr'   => $this->_message_template_group->messenger(),
2332
-            'mt'     => $this->_message_template_group->message_type(),
2333
-            'GRP_ID' => $this->_message_template_group->GRP_ID(),
2334
-        );
2335
-        // first we need to see if there are any fields
2336
-        $fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields();
2337
-
2338
-        if (! empty($fields)) {
2339
-            // yup there be fields
2340
-            foreach ($fields as $field => $config) {
2341
-                $field_id = $this->_message_template_group->messenger() . '_' . $field;
2342
-                $existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
2343
-                $default = isset($config['default']) ? $config['default'] : '';
2344
-                $default = isset($config['value']) ? $config['value'] : $default;
2345
-
2346
-                // if type is hidden and the value is empty
2347
-                // something may have gone wrong so let's correct with the defaults
2348
-                $fix = $config['input'] === 'hidden'
2349
-                       && isset($existing[ $field ])
2350
-                       && empty($existing[ $field ])
2351
-                    ? $default
2352
-                    : '';
2353
-                $existing[ $field ] = isset($existing[ $field ]) && empty($fix)
2354
-                    ? $existing[ $field ]
2355
-                    : $fix;
2356
-
2357
-                $template_form_fields[ $field_id ] = array(
2358
-                    'name'       => 'test_settings_fld[' . $field . ']',
2359
-                    'label'      => $config['label'],
2360
-                    'input'      => $config['input'],
2361
-                    'type'       => $config['type'],
2362
-                    'required'   => $config['required'],
2363
-                    'validation' => $config['validation'],
2364
-                    'value'      => isset($existing[ $field ]) ? $existing[ $field ] : $default,
2365
-                    'css_class'  => $config['css_class'],
2366
-                    'options'    => isset($config['options']) ? $config['options'] : array(),
2367
-                    'default'    => $default,
2368
-                    'format'     => $config['format'],
2369
-                );
2370
-            }
2371
-        }
2372
-
2373
-        $test_settings_fields = ! empty($template_form_fields)
2374
-            ? $this->_generate_admin_form_fields($template_form_fields, 'string', 'ee_tst_settings_flds')
2375
-            : '';
2376
-
2377
-        $test_settings_html = '';
2378
-        // print out $test_settings_fields
2379
-        if (! empty($test_settings_fields)) {
2380
-            echo $test_settings_fields;
2381
-            $test_settings_html = '<input type="submit" class="button-primary mtp-test-button alignright" ';
2382
-            $test_settings_html .= 'name="test_button" value="';
2383
-            $test_settings_html .= esc_html__('Test Send', 'event_espresso');
2384
-            $test_settings_html .= '" /><div style="clear:both"></div>';
2385
-        }
2386
-
2387
-        // and button
2388
-        $test_settings_html .= '<p>'
2389
-                               . esc_html__('Need to reset this message type and start over?', 'event_espresso')
2390
-                               . '</p>';
2391
-        $test_settings_html .= '<div class="publishing-action alignright resetbutton">';
2392
-        $test_settings_html .= $this->get_action_link_or_button(
2393
-            'reset_to_default',
2394
-            'reset',
2395
-            $extra_args,
2396
-            'button-primary reset-default-button'
2397
-        );
2398
-        $test_settings_html .= '</div><div style="clear:both"></div>';
2399
-        echo $test_settings_html;
2400
-    }
2401
-
2402
-
2403
-    /**
2404
-     * This returns the shortcode selector skeleton for a given context and field.
2405
-     *
2406
-     * @since 4.9.rc.000
2407
-     * @param string $field           The name of the field retrieving shortcodes for.
2408
-     * @param string $linked_input_id The css id of the input that the shortcodes get added to.
2409
-     * @return string
2410
-     * @throws DomainException
2411
-     * @throws EE_Error
2412
-     * @throws InvalidArgumentException
2413
-     * @throws ReflectionException
2414
-     * @throws InvalidDataTypeException
2415
-     * @throws InvalidInterfaceException
2416
-     */
2417
-    protected function _get_shortcode_selector($field, $linked_input_id)
2418
-    {
2419
-        $template_args = array(
2420
-            'shortcodes'      => $this->_get_shortcodes(array($field), true),
2421
-            'fieldname'       => $field,
2422
-            'linked_input_id' => $linked_input_id,
2423
-        );
2424
-
2425
-        return EEH_Template::display_template(
2426
-            EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
2427
-            $template_args,
2428
-            true
2429
-        );
2430
-    }
2431
-
2432
-
2433
-    /**
2434
-     * This just takes care of returning the meta box content for shortcodes (only used on the edit message template
2435
-     * page)
2436
-     *
2437
-     * @access public
2438
-     * @return void
2439
-     * @throws EE_Error
2440
-     * @throws InvalidArgumentException
2441
-     * @throws ReflectionException
2442
-     * @throws InvalidDataTypeException
2443
-     * @throws InvalidInterfaceException
2444
-     */
2445
-    public function shortcode_meta_box()
2446
-    {
2447
-        $shortcodes = $this->_get_shortcodes(array(), false); // just make sure shortcodes property is set
2448
-        // $messenger = $this->_message_template_group->messenger_obj();
2449
-        // now let's set the content depending on the status of the shortcodes array
2450
-        if (empty($shortcodes)) {
2451
-            $content = '<p>' . esc_html__('There are no valid shortcodes available', 'event_espresso') . '</p>';
2452
-            echo $content;
2453
-        } else {
2454
-            // $alt = 0;
2455
-            ?>
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
+			'sent_status'                => array(
1080
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent,
1081
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, 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
+			'failed_status'              => array(
1088
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
1089
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, 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
+			'resend_status'              => array(
1096
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend,
1097
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence'),
1098
+			),
1099
+			'incomplete_status'          => array(
1100
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
1101
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence'),
1102
+			),
1103
+			'retry_status'               => array(
1104
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry,
1105
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, 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
+		$this->_set_shortcodes(); // this also sets the _message_template property.
1312
+		$message_template_group = $this->_message_template_group;
1313
+		$c_label = $message_template_group->context_label();
1314
+		$c_config = $message_template_group->contexts_config();
1315
+
1316
+		reset($c_config);
1317
+		$context = isset($this->_req_data['context']) && ! empty($this->_req_data['context'])
1318
+			? strtolower($this->_req_data['context'])
1319
+			: key($c_config);
1320
+
1321
+
1322
+		if (empty($GRP_ID)) {
1323
+			$action = 'insert_message_template';
1324
+			$edit_message_template_form_url = add_query_arg(
1325
+				array('action' => $action, 'noheader' => true),
1326
+				EE_MSG_ADMIN_URL
1327
+			);
1328
+		} else {
1329
+			$action = 'update_message_template';
1330
+			$edit_message_template_form_url = add_query_arg(
1331
+				array('action' => $action, 'noheader' => true),
1332
+				EE_MSG_ADMIN_URL
1333
+			);
1334
+		}
1335
+
1336
+		// set active messenger for this view
1337
+		$this->_active_messenger = $this->_message_resource_manager->get_active_messenger(
1338
+			$message_template_group->messenger()
1339
+		);
1340
+		$this->_active_message_type_name = $message_template_group->message_type();
1341
+
1342
+
1343
+		// Do we have any validation errors?
1344
+		$validators = $this->_get_transient();
1345
+		$v_fields = ! empty($validators) ? array_keys($validators) : array();
1346
+
1347
+
1348
+		// we need to assemble the title from Various details
1349
+		$context_label = sprintf(
1350
+			esc_html__('(%s %s)', 'event_espresso'),
1351
+			$c_config[ $context ]['label'],
1352
+			ucwords($c_label['label'])
1353
+		);
1354
+
1355
+		$title = sprintf(
1356
+			esc_html__(' %s %s Template %s', 'event_espresso'),
1357
+			ucwords($message_template_group->messenger_obj()->label['singular']),
1358
+			ucwords($message_template_group->message_type_obj()->label['singular']),
1359
+			$context_label
1360
+		);
1361
+
1362
+		$this->_template_args['GRP_ID'] = $GRP_ID;
1363
+		$this->_template_args['message_template'] = $message_template_group;
1364
+		$this->_template_args['is_extra_fields'] = false;
1365
+
1366
+
1367
+		// let's get EEH_MSG_Template so we can get template form fields
1368
+		$template_field_structure = EEH_MSG_Template::get_fields(
1369
+			$message_template_group->messenger(),
1370
+			$message_template_group->message_type()
1371
+		);
1372
+
1373
+		if (! $template_field_structure) {
1374
+			$template_field_structure = false;
1375
+			$template_fields = esc_html__(
1376
+				'There was an error in assembling the fields for this display (you should see an error message)',
1377
+				'event_espresso'
1378
+			);
1379
+		}
1380
+
1381
+
1382
+		$message_templates = $message_template_group->context_templates();
1383
+
1384
+
1385
+		// if we have the extra key.. then we need to remove the content index from the template_field_structure as it
1386
+		// will get handled in the "extra" array.
1387
+		if (is_array($template_field_structure[ $context ]) && isset($template_field_structure[ $context ]['extra'])) {
1388
+			foreach ($template_field_structure[ $context ]['extra'] as $reference_field => $new_fields) {
1389
+				unset($template_field_structure[ $context ][ $reference_field ]);
1390
+			}
1391
+		}
1392
+
1393
+		// let's loop through the template_field_structure and actually assemble the input fields!
1394
+		if (! empty($template_field_structure)) {
1395
+			foreach ($template_field_structure[ $context ] as $template_field => $field_setup_array) {
1396
+				// if this is an 'extra' template field then we need to remove any existing fields that are keyed up in
1397
+				// the extra array and reset them.
1398
+				if ($template_field === 'extra') {
1399
+					$this->_template_args['is_extra_fields'] = true;
1400
+					foreach ($field_setup_array as $reference_field => $new_fields_array) {
1401
+						$message_template = $message_templates[ $context ][ $reference_field ];
1402
+						$content = $message_template instanceof EE_Message_Template
1403
+							? $message_template->get('MTP_content')
1404
+							: '';
1405
+						foreach ($new_fields_array as $extra_field => $extra_array) {
1406
+							// let's verify if we need this extra field via the shortcodes parameter.
1407
+							$continue = false;
1408
+							if (isset($extra_array['shortcodes_required'])) {
1409
+								foreach ((array) $extra_array['shortcodes_required'] as $shortcode) {
1410
+									if (! array_key_exists($shortcode, $this->_shortcodes)) {
1411
+										$continue = true;
1412
+									}
1413
+								}
1414
+								if ($continue) {
1415
+									continue;
1416
+								}
1417
+							}
1418
+
1419
+							$field_id = $reference_field
1420
+										. '-'
1421
+										. $extra_field
1422
+										. '-content';
1423
+							$template_form_fields[ $field_id ] = $extra_array;
1424
+							$template_form_fields[ $field_id ]['name'] = 'MTP_template_fields['
1425
+																		 . $reference_field
1426
+																		 . '][content]['
1427
+																		 . $extra_field . ']';
1428
+							$css_class = isset($extra_array['css_class'])
1429
+								? $extra_array['css_class']
1430
+								: '';
1431
+
1432
+							$template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
1433
+																			  && in_array($extra_field, $v_fields, true)
1434
+																			  &&
1435
+																			  (
1436
+																				  is_array($validators[ $extra_field ])
1437
+																				  && isset($validators[ $extra_field ]['msg'])
1438
+																			  )
1439
+								? 'validate-error ' . $css_class
1440
+								: $css_class;
1441
+
1442
+							$template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
1443
+																		  && isset($content[ $extra_field ])
1444
+								? $content[ $extra_field ]
1445
+								: '';
1446
+
1447
+							// do we have a validation error?  if we do then let's use that value instead
1448
+							$template_form_fields[ $field_id ]['value'] = isset($validators[ $extra_field ])
1449
+								? $validators[ $extra_field ]['value']
1450
+								: $template_form_fields[ $field_id ]['value'];
1451
+
1452
+
1453
+							$template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
1454
+
1455
+							// shortcode selector
1456
+							$field_name_to_use = $extra_field === 'main'
1457
+								? 'content'
1458
+								: $extra_field;
1459
+							$template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
1460
+								$field_name_to_use,
1461
+								$field_id
1462
+							);
1463
+
1464
+							if (isset($extra_array['input']) && $extra_array['input'] === 'wp_editor') {
1465
+								// we want to decode the entities
1466
+								$template_form_fields[ $field_id ]['value'] = $template_form_fields[ $field_id ]['value'];
1467
+							}/**/
1468
+						}
1469
+						$templatefield_MTP_id = $reference_field . '-MTP_ID';
1470
+						$templatefield_templatename_id = $reference_field . '-name';
1471
+
1472
+						$template_form_fields[ $templatefield_MTP_id ] = array(
1473
+							'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
1474
+							'label'      => null,
1475
+							'input'      => 'hidden',
1476
+							'type'       => 'int',
1477
+							'required'   => false,
1478
+							'validation' => false,
1479
+							'value'      => ! empty($message_templates) ? $message_template->ID() : '',
1480
+							'css_class'  => '',
1481
+							'format'     => '%d',
1482
+							'db-col'     => 'MTP_ID',
1483
+						);
1484
+
1485
+						$template_form_fields[ $templatefield_templatename_id ] = array(
1486
+							'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
1487
+							'label'      => null,
1488
+							'input'      => 'hidden',
1489
+							'type'       => 'string',
1490
+							'required'   => false,
1491
+							'validation' => true,
1492
+							'value'      => $reference_field,
1493
+							'css_class'  => '',
1494
+							'format'     => '%s',
1495
+							'db-col'     => 'MTP_template_field',
1496
+						);
1497
+					}
1498
+					continue; // skip the next stuff, we got the necessary fields here for this dataset.
1499
+				} else {
1500
+					$field_id = $template_field . '-content';
1501
+					$template_form_fields[ $field_id ] = $field_setup_array;
1502
+					$template_form_fields[ $field_id ]['name'] = 'MTP_template_fields[' . $template_field . '][content]';
1503
+					$message_template = isset($message_templates[ $context ][ $template_field ])
1504
+						? $message_templates[ $context ][ $template_field ]
1505
+						: null;
1506
+					$template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
1507
+																  && is_array($message_templates[ $context ])
1508
+																  && $message_template instanceof EE_Message_Template
1509
+						? $message_template->get('MTP_content')
1510
+						: '';
1511
+
1512
+					// do we have a validator error for this field?  if we do then we'll use that value instead
1513
+					$template_form_fields[ $field_id ]['value'] = isset($validators[ $template_field ])
1514
+						? $validators[ $template_field ]['value']
1515
+						: $template_form_fields[ $field_id ]['value'];
1516
+
1517
+
1518
+					$template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
1519
+					$css_class = isset($field_setup_array['css_class'])
1520
+						? $field_setup_array['css_class']
1521
+						: '';
1522
+					$template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
1523
+																	  && in_array($template_field, $v_fields, true)
1524
+																	  && isset($validators[ $template_field ]['msg'])
1525
+						? 'validate-error ' . $css_class
1526
+						: $css_class;
1527
+
1528
+					// shortcode selector
1529
+					$template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
1530
+						$template_field,
1531
+						$field_id
1532
+					);
1533
+				}
1534
+
1535
+				// k took care of content field(s) now let's take care of others.
1536
+
1537
+				$templatefield_MTP_id = $template_field . '-MTP_ID';
1538
+				$templatefield_field_templatename_id = $template_field . '-name';
1539
+
1540
+				// foreach template field there are actually two form fields created
1541
+				$template_form_fields[ $templatefield_MTP_id ] = array(
1542
+					'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
1543
+					'label'      => null,
1544
+					'input'      => 'hidden',
1545
+					'type'       => 'int',
1546
+					'required'   => false,
1547
+					'validation' => true,
1548
+					'value'      => $message_template instanceof EE_Message_Template ? $message_template->ID() : '',
1549
+					'css_class'  => '',
1550
+					'format'     => '%d',
1551
+					'db-col'     => 'MTP_ID',
1552
+				);
1553
+
1554
+				$template_form_fields[ $templatefield_field_templatename_id ] = array(
1555
+					'name'       => 'MTP_template_fields[' . $template_field . '][name]',
1556
+					'label'      => null,
1557
+					'input'      => 'hidden',
1558
+					'type'       => 'string',
1559
+					'required'   => false,
1560
+					'validation' => true,
1561
+					'value'      => $template_field,
1562
+					'css_class'  => '',
1563
+					'format'     => '%s',
1564
+					'db-col'     => 'MTP_template_field',
1565
+				);
1566
+			}
1567
+
1568
+			// add other fields
1569
+			$template_form_fields['ee-msg-current-context'] = array(
1570
+				'name'       => 'MTP_context',
1571
+				'label'      => null,
1572
+				'input'      => 'hidden',
1573
+				'type'       => 'string',
1574
+				'required'   => false,
1575
+				'validation' => true,
1576
+				'value'      => $context,
1577
+				'css_class'  => '',
1578
+				'format'     => '%s',
1579
+				'db-col'     => 'MTP_context',
1580
+			);
1581
+
1582
+			$template_form_fields['ee-msg-grp-id'] = array(
1583
+				'name'       => 'GRP_ID',
1584
+				'label'      => null,
1585
+				'input'      => 'hidden',
1586
+				'type'       => 'int',
1587
+				'required'   => false,
1588
+				'validation' => true,
1589
+				'value'      => $GRP_ID,
1590
+				'css_class'  => '',
1591
+				'format'     => '%d',
1592
+				'db-col'     => 'GRP_ID',
1593
+			);
1594
+
1595
+			$template_form_fields['ee-msg-messenger'] = array(
1596
+				'name'       => 'MTP_messenger',
1597
+				'label'      => null,
1598
+				'input'      => 'hidden',
1599
+				'type'       => 'string',
1600
+				'required'   => false,
1601
+				'validation' => true,
1602
+				'value'      => $message_template_group->messenger(),
1603
+				'css_class'  => '',
1604
+				'format'     => '%s',
1605
+				'db-col'     => 'MTP_messenger',
1606
+			);
1607
+
1608
+			$template_form_fields['ee-msg-message-type'] = array(
1609
+				'name'       => 'MTP_message_type',
1610
+				'label'      => null,
1611
+				'input'      => 'hidden',
1612
+				'type'       => 'string',
1613
+				'required'   => false,
1614
+				'validation' => true,
1615
+				'value'      => $message_template_group->message_type(),
1616
+				'css_class'  => '',
1617
+				'format'     => '%s',
1618
+				'db-col'     => 'MTP_message_type',
1619
+			);
1620
+
1621
+			$sidebar_form_fields['ee-msg-is-global'] = array(
1622
+				'name'       => 'MTP_is_global',
1623
+				'label'      => esc_html__('Global Template', 'event_espresso'),
1624
+				'input'      => 'hidden',
1625
+				'type'       => 'int',
1626
+				'required'   => false,
1627
+				'validation' => true,
1628
+				'value'      => $message_template_group->get('MTP_is_global'),
1629
+				'css_class'  => '',
1630
+				'format'     => '%d',
1631
+				'db-col'     => 'MTP_is_global',
1632
+			);
1633
+
1634
+			$sidebar_form_fields['ee-msg-is-override'] = array(
1635
+				'name'       => 'MTP_is_override',
1636
+				'label'      => esc_html__('Override all custom', 'event_espresso'),
1637
+				'input'      => $message_template_group->is_global() ? 'checkbox' : 'hidden',
1638
+				'type'       => 'int',
1639
+				'required'   => false,
1640
+				'validation' => true,
1641
+				'value'      => $message_template_group->get('MTP_is_override'),
1642
+				'css_class'  => '',
1643
+				'format'     => '%d',
1644
+				'db-col'     => 'MTP_is_override',
1645
+			);
1646
+
1647
+			$sidebar_form_fields['ee-msg-is-active'] = array(
1648
+				'name'       => 'MTP_is_active',
1649
+				'label'      => esc_html__('Active Template', 'event_espresso'),
1650
+				'input'      => 'hidden',
1651
+				'type'       => 'int',
1652
+				'required'   => false,
1653
+				'validation' => true,
1654
+				'value'      => $message_template_group->is_active(),
1655
+				'css_class'  => '',
1656
+				'format'     => '%d',
1657
+				'db-col'     => 'MTP_is_active',
1658
+			);
1659
+
1660
+			$sidebar_form_fields['ee-msg-deleted'] = array(
1661
+				'name'       => 'MTP_deleted',
1662
+				'label'      => null,
1663
+				'input'      => 'hidden',
1664
+				'type'       => 'int',
1665
+				'required'   => false,
1666
+				'validation' => true,
1667
+				'value'      => $message_template_group->get('MTP_deleted'),
1668
+				'css_class'  => '',
1669
+				'format'     => '%d',
1670
+				'db-col'     => 'MTP_deleted',
1671
+			);
1672
+			$sidebar_form_fields['ee-msg-author'] = array(
1673
+				'name'       => 'MTP_user_id',
1674
+				'label'      => esc_html__('Author', 'event_espresso'),
1675
+				'input'      => 'hidden',
1676
+				'type'       => 'int',
1677
+				'required'   => false,
1678
+				'validation' => false,
1679
+				'value'      => $message_template_group->user(),
1680
+				'format'     => '%d',
1681
+				'db-col'     => 'MTP_user_id',
1682
+			);
1683
+
1684
+			$sidebar_form_fields['ee-msg-route'] = array(
1685
+				'name'  => 'action',
1686
+				'input' => 'hidden',
1687
+				'type'  => 'string',
1688
+				'value' => $action,
1689
+			);
1690
+
1691
+			$sidebar_form_fields['ee-msg-id'] = array(
1692
+				'name'  => 'id',
1693
+				'input' => 'hidden',
1694
+				'type'  => 'int',
1695
+				'value' => $GRP_ID,
1696
+			);
1697
+			$sidebar_form_fields['ee-msg-evt-nonce'] = array(
1698
+				'name'  => $action . '_nonce',
1699
+				'input' => 'hidden',
1700
+				'type'  => 'string',
1701
+				'value' => wp_create_nonce($action . '_nonce'),
1702
+			);
1703
+
1704
+			if (isset($this->_req_data['template_switch']) && $this->_req_data['template_switch']) {
1705
+				$sidebar_form_fields['ee-msg-template-switch'] = array(
1706
+					'name'  => 'template_switch',
1707
+					'input' => 'hidden',
1708
+					'type'  => 'int',
1709
+					'value' => 1,
1710
+				);
1711
+			}
1712
+
1713
+
1714
+			$template_fields = $this->_generate_admin_form_fields($template_form_fields);
1715
+			$sidebar_fields = $this->_generate_admin_form_fields($sidebar_form_fields);
1716
+		} //end if ( !empty($template_field_structure) )
1717
+
1718
+		// set extra content for publish box
1719
+		$this->_template_args['publish_box_extra_content'] = $sidebar_fields;
1720
+		$this->_set_publish_post_box_vars(
1721
+			'id',
1722
+			$GRP_ID,
1723
+			false,
1724
+			add_query_arg(
1725
+				array('action' => 'global_mtps'),
1726
+				$this->_admin_base_url
1727
+			)
1728
+		);
1729
+
1730
+		// add preview button
1731
+		$preview_url = parent::add_query_args_and_nonce(
1732
+			array(
1733
+				'message_type' => $message_template_group->message_type(),
1734
+				'messenger'    => $message_template_group->messenger(),
1735
+				'context'      => $context,
1736
+				'GRP_ID'       => $GRP_ID,
1737
+				'action'       => 'preview_message',
1738
+			),
1739
+			$this->_admin_base_url
1740
+		);
1741
+		$preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">'
1742
+						  . esc_html__('Preview', 'event_espresso')
1743
+						  . '</a>';
1744
+
1745
+
1746
+		// setup context switcher
1747
+		$context_switcher_args = array(
1748
+			'page'    => 'espresso_messages',
1749
+			'action'  => 'edit_message_template',
1750
+			'id'      => $GRP_ID,
1751
+			'context' => $context,
1752
+			'extra'   => $preview_button,
1753
+		);
1754
+		$this->_set_context_switcher($message_template_group, $context_switcher_args);
1755
+
1756
+
1757
+		// main box
1758
+		$this->_template_args['template_fields'] = $template_fields;
1759
+		$this->_template_args['sidebar_box_id'] = 'details';
1760
+		$this->_template_args['action'] = $action;
1761
+		$this->_template_args['context'] = $context;
1762
+		$this->_template_args['edit_message_template_form_url'] = $edit_message_template_form_url;
1763
+		$this->_template_args['learn_more_about_message_templates_link'] =
1764
+			$this->_learn_more_about_message_templates_link();
1765
+
1766
+
1767
+		$this->_template_args['before_admin_page_content'] = $this->add_context_switcher();
1768
+		$this->_template_args['before_admin_page_content'] .= $this->add_active_context_element(
1769
+			$message_template_group,
1770
+			$context,
1771
+			$context_label
1772
+		);
1773
+		$this->_template_args['before_admin_page_content'] .= $this->_add_form_element_before();
1774
+		$this->_template_args['after_admin_page_content'] = $this->_add_form_element_after();
1775
+
1776
+		$this->_template_path = $this->_template_args['GRP_ID']
1777
+			? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
1778
+			: EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
1779
+
1780
+		// send along EE_Message_Template_Group object for further template use.
1781
+		$this->_template_args['MTP'] = $message_template_group;
1782
+
1783
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
1784
+			$this->_template_path,
1785
+			$this->_template_args,
1786
+			true
1787
+		);
1788
+
1789
+
1790
+		// finally, let's set the admin_page title
1791
+		$this->_admin_page_title = sprintf(__('Editing %s', 'event_espresso'), $title);
1792
+
1793
+
1794
+		// we need to take care of setting the shortcodes property for use elsewhere.
1795
+		$this->_set_shortcodes();
1796
+
1797
+
1798
+		// final template wrapper
1799
+		$this->display_admin_page_with_sidebar();
1800
+	}
1801
+
1802
+
1803
+	public function filter_tinymce_init($mceInit, $editor_id)
1804
+	{
1805
+		return $mceInit;
1806
+	}
1807
+
1808
+
1809
+	public function add_context_switcher()
1810
+	{
1811
+		return $this->_context_switcher;
1812
+	}
1813
+
1814
+
1815
+	/**
1816
+	 * Adds the activation/deactivation toggle for the message template context.
1817
+	 *
1818
+	 * @param EE_Message_Template_Group $message_template_group
1819
+	 * @param string                    $context
1820
+	 * @param string                    $context_label
1821
+	 * @return string
1822
+	 * @throws DomainException
1823
+	 * @throws EE_Error
1824
+	 * @throws InvalidIdentifierException
1825
+	 */
1826
+	protected function add_active_context_element(
1827
+		EE_Message_Template_Group $message_template_group,
1828
+		$context,
1829
+		$context_label
1830
+	) {
1831
+		$template_args = array(
1832
+			'context'                   => $context,
1833
+			'nonce'                     => wp_create_nonce('activate_' . $context . '_toggle_nonce'),
1834
+			'is_active'                 => $message_template_group->is_context_active($context),
1835
+			'on_off_action'             => $message_template_group->is_context_active($context)
1836
+				? 'context-off'
1837
+				: 'context-on',
1838
+			'context_label'             => str_replace(array('(', ')'), '', $context_label),
1839
+			'message_template_group_id' => $message_template_group->ID(),
1840
+		);
1841
+		return EEH_Template::display_template(
1842
+			EE_MSG_TEMPLATE_PATH . 'ee_msg_editor_active_context_element.template.php',
1843
+			$template_args,
1844
+			true
1845
+		);
1846
+	}
1847
+
1848
+
1849
+	/**
1850
+	 * Ajax callback for `toggle_context_template` ajax action.
1851
+	 * Handles toggling the message context on or off.
1852
+	 *
1853
+	 * @throws EE_Error
1854
+	 * @throws InvalidArgumentException
1855
+	 * @throws InvalidDataTypeException
1856
+	 * @throws InvalidIdentifierException
1857
+	 * @throws InvalidInterfaceException
1858
+	 */
1859
+	public function toggle_context_template()
1860
+	{
1861
+		$success = true;
1862
+		// check for required data
1863
+		if (! isset(
1864
+			$this->_req_data['message_template_group_id'],
1865
+			$this->_req_data['context'],
1866
+			$this->_req_data['status']
1867
+		)) {
1868
+			EE_Error::add_error(
1869
+				esc_html__('Required data for doing this action is not available.', 'event_espresso'),
1870
+				__FILE__,
1871
+				__FUNCTION__,
1872
+				__LINE__
1873
+			);
1874
+			$success = false;
1875
+		}
1876
+
1877
+		$nonce = isset($this->_req_data['toggle_context_nonce'])
1878
+			? sanitize_text_field($this->_req_data['toggle_context_nonce'])
1879
+			: '';
1880
+		$nonce_ref = 'activate_' . $this->_req_data['context'] . '_toggle_nonce';
1881
+		$this->_verify_nonce($nonce, $nonce_ref);
1882
+		$status = $this->_req_data['status'];
1883
+		if ($status !== 'off' && $status !== 'on') {
1884
+			EE_Error::add_error(
1885
+				sprintf(
1886
+					esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
1887
+					$this->_req_data['status']
1888
+				),
1889
+				__FILE__,
1890
+				__FUNCTION__,
1891
+				__LINE__
1892
+			);
1893
+			$success = false;
1894
+		}
1895
+		$message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID(
1896
+			$this->_req_data['message_template_group_id']
1897
+		);
1898
+		if (! $message_template_group instanceof EE_Message_Template_Group) {
1899
+			EE_Error::add_error(
1900
+				sprintf(
1901
+					esc_html__(
1902
+						'Unable to change the active state because the given id "%1$d" does not match a valid "%2$s"',
1903
+						'event_espresso'
1904
+					),
1905
+					$this->_req_data['message_template_group_id'],
1906
+					'EE_Message_Template_Group'
1907
+				),
1908
+				__FILE__,
1909
+				__FUNCTION__,
1910
+				__LINE__
1911
+			);
1912
+			$success = false;
1913
+		}
1914
+		if ($success) {
1915
+			$success = $status === 'off'
1916
+				? $message_template_group->deactivate_context($this->_req_data['context'])
1917
+				: $message_template_group->activate_context($this->_req_data['context']);
1918
+		}
1919
+		$this->_template_args['success'] = $success;
1920
+		$this->_return_json();
1921
+	}
1922
+
1923
+
1924
+	public function _add_form_element_before()
1925
+	{
1926
+		return '<form method="post" action="'
1927
+			   . $this->_template_args["edit_message_template_form_url"]
1928
+			   . '" id="ee-msg-edit-frm">';
1929
+	}
1930
+
1931
+	public function _add_form_element_after()
1932
+	{
1933
+		return '</form>';
1934
+	}
1935
+
1936
+
1937
+	/**
1938
+	 * This executes switching the template pack for a message template.
1939
+	 *
1940
+	 * @since 4.5.0
1941
+	 * @throws EE_Error
1942
+	 * @throws InvalidDataTypeException
1943
+	 * @throws InvalidInterfaceException
1944
+	 * @throws InvalidArgumentException
1945
+	 * @throws ReflectionException
1946
+	 */
1947
+	public function switch_template_pack()
1948
+	{
1949
+		$GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
1950
+		$template_pack = ! empty($this->_req_data['template_pack']) ? $this->_req_data['template_pack'] : '';
1951
+
1952
+		// verify we have needed values.
1953
+		if (empty($GRP_ID) || empty($template_pack)) {
1954
+			$this->_template_args['error'] = true;
1955
+			EE_Error::add_error(
1956
+				esc_html__('The required date for switching templates is not available.', 'event_espresso'),
1957
+				__FILE__,
1958
+				__FUNCTION__,
1959
+				__LINE__
1960
+			);
1961
+		} else {
1962
+			// get template, set the new template_pack and then reset to default
1963
+			/** @type EE_Message_Template_Group $message_template_group */
1964
+			$message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
1965
+
1966
+			$message_template_group->set_template_pack_name($template_pack);
1967
+			$this->_req_data['msgr'] = $message_template_group->messenger();
1968
+			$this->_req_data['mt'] = $message_template_group->message_type();
1969
+
1970
+			$query_args = $this->_reset_to_default_template();
1971
+
1972
+			if (empty($query_args['id'])) {
1973
+				EE_Error::add_error(
1974
+					esc_html__(
1975
+						'Something went wrong with switching the template pack. Please try again or contact EE support',
1976
+						'event_espresso'
1977
+					),
1978
+					__FILE__,
1979
+					__FUNCTION__,
1980
+					__LINE__
1981
+				);
1982
+				$this->_template_args['error'] = true;
1983
+			} else {
1984
+				$template_label = $message_template_group->get_template_pack()->label;
1985
+				$template_pack_labels = $message_template_group->messenger_obj()->get_supports_labels();
1986
+				EE_Error::add_success(
1987
+					sprintf(
1988
+						esc_html__(
1989
+							'This message template has been successfully switched to use the %1$s %2$s.  Please wait while the page reloads with your new template.',
1990
+							'event_espresso'
1991
+						),
1992
+						$template_label,
1993
+						$template_pack_labels->template_pack
1994
+					)
1995
+				);
1996
+				// generate the redirect url for js.
1997
+				$url = self::add_query_args_and_nonce(
1998
+					$query_args,
1999
+					$this->_admin_base_url
2000
+				);
2001
+				$this->_template_args['data']['redirect_url'] = $url;
2002
+				$this->_template_args['success'] = true;
2003
+			}
2004
+
2005
+			$this->_return_json();
2006
+		}
2007
+	}
2008
+
2009
+
2010
+	/**
2011
+	 * This handles resetting the template for the given messenger/message_type so that users can start from scratch if
2012
+	 * they want.
2013
+	 *
2014
+	 * @access protected
2015
+	 * @return array|null
2016
+	 * @throws EE_Error
2017
+	 * @throws InvalidArgumentException
2018
+	 * @throws InvalidDataTypeException
2019
+	 * @throws InvalidInterfaceException
2020
+	 */
2021
+	protected function _reset_to_default_template()
2022
+	{
2023
+
2024
+		$templates = array();
2025
+		$GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
2026
+		// we need to make sure we've got the info we need.
2027
+		if (! isset($this->_req_data['msgr'], $this->_req_data['mt'], $this->_req_data['GRP_ID'])) {
2028
+			EE_Error::add_error(
2029
+				esc_html__(
2030
+					'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.',
2031
+					'event_espresso'
2032
+				),
2033
+				__FILE__,
2034
+				__FUNCTION__,
2035
+				__LINE__
2036
+			);
2037
+		}
2038
+
2039
+		// all templates will be reset to whatever the defaults are
2040
+		// for the global template matching the messenger and message type.
2041
+		$success = ! empty($GRP_ID) ? true : false;
2042
+
2043
+		if ($success) {
2044
+			// let's first determine if the incoming template is a global template,
2045
+			// if it isn't then we need to get the global template matching messenger and message type.
2046
+			// $MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID );
2047
+
2048
+
2049
+			// note this is ONLY deleting the template fields (Message Template rows) NOT the message template group.
2050
+			$success = $this->_delete_mtp_permanently($GRP_ID, false);
2051
+
2052
+			if ($success) {
2053
+				// if successfully deleted, lets generate the new ones.
2054
+				// Note. We set GLOBAL to true, because resets on ANY template
2055
+				// will use the related global template defaults for regeneration.
2056
+				// This means that if a custom template is reset it resets to whatever the related global template is.
2057
+				// HOWEVER, we DO keep the template pack and template variation set
2058
+				// for the current custom template when resetting.
2059
+				$templates = $this->_generate_new_templates(
2060
+					$this->_req_data['msgr'],
2061
+					$this->_req_data['mt'],
2062
+					$GRP_ID,
2063
+					true
2064
+				);
2065
+			}
2066
+		}
2067
+
2068
+		// any error messages?
2069
+		if (! $success) {
2070
+			EE_Error::add_error(
2071
+				esc_html__(
2072
+					'Something went wrong with deleting existing templates. Unable to reset to default',
2073
+					'event_espresso'
2074
+				),
2075
+				__FILE__,
2076
+				__FUNCTION__,
2077
+				__LINE__
2078
+			);
2079
+		}
2080
+
2081
+		// all good, let's add a success message!
2082
+		if ($success && ! empty($templates)) {
2083
+			// the info for the template we generated is the first element in the returned array
2084
+			// $templates = $templates[0];
2085
+			EE_Error::overwrite_success();
2086
+			EE_Error::add_success(__('Templates have been reset to defaults.', 'event_espresso'));
2087
+		}
2088
+
2089
+
2090
+		$query_args = array(
2091
+			'id'      => isset($templates['GRP_ID']) ? $templates['GRP_ID'] : null,
2092
+			'context' => isset($templates['MTP_context']) ? $templates['MTP_context'] : null,
2093
+			'action'  => isset($templates['GRP_ID']) ? 'edit_message_template' : 'global_mtps',
2094
+		);
2095
+
2096
+		// if called via ajax then we return query args otherwise redirect
2097
+		if (defined('DOING_AJAX') && DOING_AJAX) {
2098
+			return $query_args;
2099
+		} else {
2100
+			$this->_redirect_after_action(false, '', '', $query_args, true);
2101
+
2102
+			return null;
2103
+		}
2104
+	}
2105
+
2106
+
2107
+	/**
2108
+	 * Retrieve and set the message preview for display.
2109
+	 *
2110
+	 * @param bool $send if TRUE then we are doing an actual TEST send with the results of the preview.
2111
+	 * @return string
2112
+	 * @throws ReflectionException
2113
+	 * @throws EE_Error
2114
+	 * @throws InvalidArgumentException
2115
+	 * @throws InvalidDataTypeException
2116
+	 * @throws InvalidInterfaceException
2117
+	 */
2118
+	public function _preview_message($send = false)
2119
+	{
2120
+		// first make sure we've got the necessary parameters
2121
+		if (! isset(
2122
+			$this->_req_data['message_type'],
2123
+			$this->_req_data['messenger'],
2124
+			$this->_req_data['messenger'],
2125
+			$this->_req_data['GRP_ID']
2126
+		)) {
2127
+			EE_Error::add_error(
2128
+				esc_html__('Missing necessary parameters for displaying preview', 'event_espresso'),
2129
+				__FILE__,
2130
+				__FUNCTION__,
2131
+				__LINE__
2132
+			);
2133
+		}
2134
+
2135
+		EE_Registry::instance()->REQ->set('GRP_ID', $this->_req_data['GRP_ID']);
2136
+
2137
+
2138
+		// get the preview!
2139
+		$preview = EED_Messages::preview_message(
2140
+			$this->_req_data['message_type'],
2141
+			$this->_req_data['context'],
2142
+			$this->_req_data['messenger'],
2143
+			$send
2144
+		);
2145
+
2146
+		if ($send) {
2147
+			return $preview;
2148
+		}
2149
+
2150
+		// let's add a button to go back to the edit view
2151
+		$query_args = array(
2152
+			'id'      => $this->_req_data['GRP_ID'],
2153
+			'context' => $this->_req_data['context'],
2154
+			'action'  => 'edit_message_template',
2155
+		);
2156
+		$go_back_url = parent::add_query_args_and_nonce($query_args, $this->_admin_base_url);
2157
+		$preview_button = '<a href="'
2158
+						  . $go_back_url
2159
+						  . '" class="button-secondary messages-preview-go-back-button">'
2160
+						  . esc_html__('Go Back to Edit', 'event_espresso')
2161
+						  . '</a>';
2162
+		$message_types = $this->get_installed_message_types();
2163
+		$active_messenger = $this->_message_resource_manager->get_active_messenger(
2164
+			$this->_req_data['messenger']
2165
+		);
2166
+		$active_messenger_label = $active_messenger instanceof EE_messenger
2167
+			? ucwords($active_messenger->label['singular'])
2168
+			: esc_html__('Unknown Messenger', 'event_espresso');
2169
+		// let's provide a helpful title for context
2170
+		$preview_title = sprintf(
2171
+			esc_html__('Viewing Preview for %s %s Message Template', 'event_espresso'),
2172
+			$active_messenger_label,
2173
+			ucwords($message_types[ $this->_req_data['message_type'] ]->label['singular'])
2174
+		);
2175
+		// setup display of preview.
2176
+		$this->_admin_page_title = $preview_title;
2177
+		$this->_template_args['admin_page_content'] = $preview_button . '<br />' . $preview;
2178
+		$this->_template_args['data']['force_json'] = true;
2179
+
2180
+		return '';
2181
+	}
2182
+
2183
+
2184
+	/**
2185
+	 * The initial _preview_message is on a no headers route.  It will optionally call this if necessary otherwise it
2186
+	 * gets called automatically.
2187
+	 *
2188
+	 * @since 4.5.0
2189
+	 *
2190
+	 * @return string
2191
+	 */
2192
+	protected function _display_preview_message()
2193
+	{
2194
+		$this->display_admin_page_with_no_sidebar();
2195
+	}
2196
+
2197
+
2198
+	/**
2199
+	 * registers metaboxes that should show up on the "edit_message_template" page
2200
+	 *
2201
+	 * @access protected
2202
+	 * @return void
2203
+	 */
2204
+	protected function _register_edit_meta_boxes()
2205
+	{
2206
+		add_meta_box(
2207
+			'mtp_valid_shortcodes',
2208
+			esc_html__('Valid Shortcodes', 'event_espresso'),
2209
+			array($this, 'shortcode_meta_box'),
2210
+			$this->_current_screen->id,
2211
+			'side',
2212
+			'default'
2213
+		);
2214
+		add_meta_box(
2215
+			'mtp_extra_actions',
2216
+			esc_html__('Extra Actions', 'event_espresso'),
2217
+			array($this, 'extra_actions_meta_box'),
2218
+			$this->_current_screen->id,
2219
+			'side',
2220
+			'high'
2221
+		);
2222
+		add_meta_box(
2223
+			'mtp_templates',
2224
+			esc_html__('Template Styles', 'event_espresso'),
2225
+			array($this, 'template_pack_meta_box'),
2226
+			$this->_current_screen->id,
2227
+			'side',
2228
+			'high'
2229
+		);
2230
+	}
2231
+
2232
+
2233
+	/**
2234
+	 * metabox content for all template pack and variation selection.
2235
+	 *
2236
+	 * @since 4.5.0
2237
+	 * @return string
2238
+	 * @throws DomainException
2239
+	 * @throws EE_Error
2240
+	 * @throws InvalidArgumentException
2241
+	 * @throws ReflectionException
2242
+	 * @throws InvalidDataTypeException
2243
+	 * @throws InvalidInterfaceException
2244
+	 */
2245
+	public function template_pack_meta_box()
2246
+	{
2247
+		$this->_set_message_template_group();
2248
+
2249
+		$tp_collection = EEH_MSG_Template::get_template_pack_collection();
2250
+
2251
+		$tp_select_values = array();
2252
+
2253
+		foreach ($tp_collection as $tp) {
2254
+			// only include template packs that support this messenger and message type!
2255
+			$supports = $tp->get_supports();
2256
+			if (! isset($supports[ $this->_message_template_group->messenger() ])
2257
+				|| ! in_array(
2258
+					$this->_message_template_group->message_type(),
2259
+					$supports[ $this->_message_template_group->messenger() ],
2260
+					true
2261
+				)
2262
+			) {
2263
+				// not supported
2264
+				continue;
2265
+			}
2266
+
2267
+			$tp_select_values[] = array(
2268
+				'text' => $tp->label,
2269
+				'id'   => $tp->dbref,
2270
+			);
2271
+		}
2272
+
2273
+		// if empty $tp_select_values then we make sure default is set because EVERY message type should be supported by
2274
+		// the default template pack.  This still allows for the odd template pack to override.
2275
+		if (empty($tp_select_values)) {
2276
+			$tp_select_values[] = array(
2277
+				'text' => esc_html__('Default', 'event_espresso'),
2278
+				'id'   => 'default',
2279
+			);
2280
+		}
2281
+
2282
+		// setup variation select values for the currently selected template.
2283
+		$variations = $this->_message_template_group->get_template_pack()->get_variations(
2284
+			$this->_message_template_group->messenger(),
2285
+			$this->_message_template_group->message_type()
2286
+		);
2287
+		$variations_select_values = array();
2288
+		foreach ($variations as $variation => $label) {
2289
+			$variations_select_values[] = array(
2290
+				'text' => $label,
2291
+				'id'   => $variation,
2292
+			);
2293
+		}
2294
+
2295
+		$template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels();
2296
+
2297
+		$template_args['template_packs_selector'] = EEH_Form_Fields::select_input(
2298
+			'MTP_template_pack',
2299
+			$tp_select_values,
2300
+			$this->_message_template_group->get_template_pack_name()
2301
+		);
2302
+		$template_args['variations_selector'] = EEH_Form_Fields::select_input(
2303
+			'MTP_template_variation',
2304
+			$variations_select_values,
2305
+			$this->_message_template_group->get_template_pack_variation()
2306
+		);
2307
+		$template_args['template_pack_label'] = $template_pack_labels->template_pack;
2308
+		$template_args['template_variation_label'] = $template_pack_labels->template_variation;
2309
+		$template_args['template_pack_description'] = $template_pack_labels->template_pack_description;
2310
+		$template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
2311
+
2312
+		$template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
2313
+
2314
+		EEH_Template::display_template($template, $template_args);
2315
+	}
2316
+
2317
+
2318
+	/**
2319
+	 * This meta box holds any extra actions related to Message Templates
2320
+	 * For now, this includes Resetting templates to defaults and sending a test email.
2321
+	 *
2322
+	 * @access  public
2323
+	 * @return void
2324
+	 * @throws EE_Error
2325
+	 */
2326
+	public function extra_actions_meta_box()
2327
+	{
2328
+		$template_form_fields = array();
2329
+
2330
+		$extra_args = array(
2331
+			'msgr'   => $this->_message_template_group->messenger(),
2332
+			'mt'     => $this->_message_template_group->message_type(),
2333
+			'GRP_ID' => $this->_message_template_group->GRP_ID(),
2334
+		);
2335
+		// first we need to see if there are any fields
2336
+		$fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields();
2337
+
2338
+		if (! empty($fields)) {
2339
+			// yup there be fields
2340
+			foreach ($fields as $field => $config) {
2341
+				$field_id = $this->_message_template_group->messenger() . '_' . $field;
2342
+				$existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
2343
+				$default = isset($config['default']) ? $config['default'] : '';
2344
+				$default = isset($config['value']) ? $config['value'] : $default;
2345
+
2346
+				// if type is hidden and the value is empty
2347
+				// something may have gone wrong so let's correct with the defaults
2348
+				$fix = $config['input'] === 'hidden'
2349
+					   && isset($existing[ $field ])
2350
+					   && empty($existing[ $field ])
2351
+					? $default
2352
+					: '';
2353
+				$existing[ $field ] = isset($existing[ $field ]) && empty($fix)
2354
+					? $existing[ $field ]
2355
+					: $fix;
2356
+
2357
+				$template_form_fields[ $field_id ] = array(
2358
+					'name'       => 'test_settings_fld[' . $field . ']',
2359
+					'label'      => $config['label'],
2360
+					'input'      => $config['input'],
2361
+					'type'       => $config['type'],
2362
+					'required'   => $config['required'],
2363
+					'validation' => $config['validation'],
2364
+					'value'      => isset($existing[ $field ]) ? $existing[ $field ] : $default,
2365
+					'css_class'  => $config['css_class'],
2366
+					'options'    => isset($config['options']) ? $config['options'] : array(),
2367
+					'default'    => $default,
2368
+					'format'     => $config['format'],
2369
+				);
2370
+			}
2371
+		}
2372
+
2373
+		$test_settings_fields = ! empty($template_form_fields)
2374
+			? $this->_generate_admin_form_fields($template_form_fields, 'string', 'ee_tst_settings_flds')
2375
+			: '';
2376
+
2377
+		$test_settings_html = '';
2378
+		// print out $test_settings_fields
2379
+		if (! empty($test_settings_fields)) {
2380
+			echo $test_settings_fields;
2381
+			$test_settings_html = '<input type="submit" class="button-primary mtp-test-button alignright" ';
2382
+			$test_settings_html .= 'name="test_button" value="';
2383
+			$test_settings_html .= esc_html__('Test Send', 'event_espresso');
2384
+			$test_settings_html .= '" /><div style="clear:both"></div>';
2385
+		}
2386
+
2387
+		// and button
2388
+		$test_settings_html .= '<p>'
2389
+							   . esc_html__('Need to reset this message type and start over?', 'event_espresso')
2390
+							   . '</p>';
2391
+		$test_settings_html .= '<div class="publishing-action alignright resetbutton">';
2392
+		$test_settings_html .= $this->get_action_link_or_button(
2393
+			'reset_to_default',
2394
+			'reset',
2395
+			$extra_args,
2396
+			'button-primary reset-default-button'
2397
+		);
2398
+		$test_settings_html .= '</div><div style="clear:both"></div>';
2399
+		echo $test_settings_html;
2400
+	}
2401
+
2402
+
2403
+	/**
2404
+	 * This returns the shortcode selector skeleton for a given context and field.
2405
+	 *
2406
+	 * @since 4.9.rc.000
2407
+	 * @param string $field           The name of the field retrieving shortcodes for.
2408
+	 * @param string $linked_input_id The css id of the input that the shortcodes get added to.
2409
+	 * @return string
2410
+	 * @throws DomainException
2411
+	 * @throws EE_Error
2412
+	 * @throws InvalidArgumentException
2413
+	 * @throws ReflectionException
2414
+	 * @throws InvalidDataTypeException
2415
+	 * @throws InvalidInterfaceException
2416
+	 */
2417
+	protected function _get_shortcode_selector($field, $linked_input_id)
2418
+	{
2419
+		$template_args = array(
2420
+			'shortcodes'      => $this->_get_shortcodes(array($field), true),
2421
+			'fieldname'       => $field,
2422
+			'linked_input_id' => $linked_input_id,
2423
+		);
2424
+
2425
+		return EEH_Template::display_template(
2426
+			EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
2427
+			$template_args,
2428
+			true
2429
+		);
2430
+	}
2431
+
2432
+
2433
+	/**
2434
+	 * This just takes care of returning the meta box content for shortcodes (only used on the edit message template
2435
+	 * page)
2436
+	 *
2437
+	 * @access public
2438
+	 * @return void
2439
+	 * @throws EE_Error
2440
+	 * @throws InvalidArgumentException
2441
+	 * @throws ReflectionException
2442
+	 * @throws InvalidDataTypeException
2443
+	 * @throws InvalidInterfaceException
2444
+	 */
2445
+	public function shortcode_meta_box()
2446
+	{
2447
+		$shortcodes = $this->_get_shortcodes(array(), false); // just make sure shortcodes property is set
2448
+		// $messenger = $this->_message_template_group->messenger_obj();
2449
+		// now let's set the content depending on the status of the shortcodes array
2450
+		if (empty($shortcodes)) {
2451
+			$content = '<p>' . esc_html__('There are no valid shortcodes available', 'event_espresso') . '</p>';
2452
+			echo $content;
2453
+		} else {
2454
+			// $alt = 0;
2455
+			?>
2456 2456
             <div style="float:right; margin-top:10px"><?php
2457
-                            echo $this->_get_help_tab_link('message_template_shortcodes');
2458
-                            ?></div>
2457
+							echo $this->_get_help_tab_link('message_template_shortcodes');
2458
+							?></div>
2459 2459
             <p class="small-text"><?php
2460
-                                  printf(
2461
-                                      esc_html__(
2462
-                                          'You can view the shortcodes usable in your template by clicking the %s icon next to each field.',
2463
-                                          'event_espresso'
2464
-                                      ),
2465
-                                      '<span class="dashicons dashicons-menu"></span>'
2466
-                                  );
2467
-                                ?>
2460
+								  printf(
2461
+									  esc_html__(
2462
+										  'You can view the shortcodes usable in your template by clicking the %s icon next to each field.',
2463
+										  'event_espresso'
2464
+									  ),
2465
+									  '<span class="dashicons dashicons-menu"></span>'
2466
+								  );
2467
+								?>
2468 2468
             </p>
2469 2469
             <?php
2470
-        }
2471
-    }
2472
-
2473
-
2474
-    /**
2475
-     * used to set the $_shortcodes property for when its needed elsewhere.
2476
-     *
2477
-     * @access protected
2478
-     * @return void
2479
-     * @throws EE_Error
2480
-     * @throws InvalidArgumentException
2481
-     * @throws ReflectionException
2482
-     * @throws InvalidDataTypeException
2483
-     * @throws InvalidInterfaceException
2484
-     */
2485
-    protected function _set_shortcodes()
2486
-    {
2487
-
2488
-        // no need to run this if the property is already set
2489
-        if (! empty($this->_shortcodes)) {
2490
-            return;
2491
-        }
2492
-
2493
-        $this->_shortcodes = $this->_get_shortcodes();
2494
-    }
2495
-
2496
-
2497
-    /**
2498
-     * get's all shortcodes for a given template group. (typically used by _set_shortcodes to set the $_shortcodes
2499
-     * property)
2500
-     *
2501
-     * @access  protected
2502
-     * @param  array   $fields include an array of specific field names that you want to be used to get the shortcodes
2503
-     *                         for. Defaults to all (for the given context)
2504
-     * @param  boolean $merged Whether to merge all the shortcodes into one list of unique shortcodes
2505
-     * @return array Shortcodes indexed by fieldname and the an array of shortcode/label pairs OR if merged is
2506
-     *                         true just an array of shortcode/label pairs.
2507
-     * @throws EE_Error
2508
-     * @throws InvalidArgumentException
2509
-     * @throws ReflectionException
2510
-     * @throws InvalidDataTypeException
2511
-     * @throws InvalidInterfaceException
2512
-     */
2513
-    protected function _get_shortcodes($fields = array(), $merged = true)
2514
-    {
2515
-        $this->_set_message_template_group();
2516
-
2517
-        // we need the messenger and message template to retrieve the valid shortcodes array.
2518
-        $GRP_ID = isset($this->_req_data['id']) && ! empty($this->_req_data['id'])
2519
-            ? absint($this->_req_data['id'])
2520
-            : false;
2521
-        $context = isset($this->_req_data['context'])
2522
-            ? $this->_req_data['context']
2523
-            : key($this->_message_template_group->contexts_config());
2524
-
2525
-        return ! empty($GRP_ID) ? $this->_message_template_group->get_shortcodes($context, $fields, $merged) : array();
2526
-    }
2527
-
2528
-
2529
-    /**
2530
-     * This sets the _message_template property (containing the called message_template object)
2531
-     *
2532
-     * @access protected
2533
-     * @return void
2534
-     * @throws EE_Error
2535
-     * @throws InvalidArgumentException
2536
-     * @throws ReflectionException
2537
-     * @throws InvalidDataTypeException
2538
-     * @throws InvalidInterfaceException
2539
-     */
2540
-    protected function _set_message_template_group()
2541
-    {
2542
-
2543
-        if (! empty($this->_message_template_group)) {
2544
-            return;
2545
-        } //get out if this is already set.
2546
-
2547
-        $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? absint($this->_req_data['GRP_ID']) : false;
2548
-        $GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['id']) ? $this->_req_data['id'] : $GRP_ID;
2549
-
2550
-        // let's get the message templates
2551
-        $MTP = EEM_Message_Template_Group::instance();
2552
-
2553
-        if (empty($GRP_ID)) {
2554
-            $this->_message_template_group = $MTP->create_default_object();
2555
-        } else {
2556
-            $this->_message_template_group = $MTP->get_one_by_ID($GRP_ID);
2557
-        }
2558
-
2559
-        $this->_template_pack = $this->_message_template_group->get_template_pack();
2560
-        $this->_variation = $this->_message_template_group->get_template_pack_variation();
2561
-    }
2562
-
2563
-
2564
-    /**
2565
-     * sets up a context switcher for edit forms
2566
-     *
2567
-     * @access  protected
2568
-     * @param  EE_Message_Template_Group $template_group_object the template group object being displayed on the form
2569
-     * @param array                      $args                  various things the context switcher needs.
2570
-     * @throws EE_Error
2571
-     */
2572
-    protected function _set_context_switcher(EE_Message_Template_Group $template_group_object, $args)
2573
-    {
2574
-        $context_details = $template_group_object->contexts_config();
2575
-        $context_label = $template_group_object->context_label();
2576
-        ob_start();
2577
-        ?>
2470
+		}
2471
+	}
2472
+
2473
+
2474
+	/**
2475
+	 * used to set the $_shortcodes property for when its needed elsewhere.
2476
+	 *
2477
+	 * @access protected
2478
+	 * @return void
2479
+	 * @throws EE_Error
2480
+	 * @throws InvalidArgumentException
2481
+	 * @throws ReflectionException
2482
+	 * @throws InvalidDataTypeException
2483
+	 * @throws InvalidInterfaceException
2484
+	 */
2485
+	protected function _set_shortcodes()
2486
+	{
2487
+
2488
+		// no need to run this if the property is already set
2489
+		if (! empty($this->_shortcodes)) {
2490
+			return;
2491
+		}
2492
+
2493
+		$this->_shortcodes = $this->_get_shortcodes();
2494
+	}
2495
+
2496
+
2497
+	/**
2498
+	 * get's all shortcodes for a given template group. (typically used by _set_shortcodes to set the $_shortcodes
2499
+	 * property)
2500
+	 *
2501
+	 * @access  protected
2502
+	 * @param  array   $fields include an array of specific field names that you want to be used to get the shortcodes
2503
+	 *                         for. Defaults to all (for the given context)
2504
+	 * @param  boolean $merged Whether to merge all the shortcodes into one list of unique shortcodes
2505
+	 * @return array Shortcodes indexed by fieldname and the an array of shortcode/label pairs OR if merged is
2506
+	 *                         true just an array of shortcode/label pairs.
2507
+	 * @throws EE_Error
2508
+	 * @throws InvalidArgumentException
2509
+	 * @throws ReflectionException
2510
+	 * @throws InvalidDataTypeException
2511
+	 * @throws InvalidInterfaceException
2512
+	 */
2513
+	protected function _get_shortcodes($fields = array(), $merged = true)
2514
+	{
2515
+		$this->_set_message_template_group();
2516
+
2517
+		// we need the messenger and message template to retrieve the valid shortcodes array.
2518
+		$GRP_ID = isset($this->_req_data['id']) && ! empty($this->_req_data['id'])
2519
+			? absint($this->_req_data['id'])
2520
+			: false;
2521
+		$context = isset($this->_req_data['context'])
2522
+			? $this->_req_data['context']
2523
+			: key($this->_message_template_group->contexts_config());
2524
+
2525
+		return ! empty($GRP_ID) ? $this->_message_template_group->get_shortcodes($context, $fields, $merged) : array();
2526
+	}
2527
+
2528
+
2529
+	/**
2530
+	 * This sets the _message_template property (containing the called message_template object)
2531
+	 *
2532
+	 * @access protected
2533
+	 * @return void
2534
+	 * @throws EE_Error
2535
+	 * @throws InvalidArgumentException
2536
+	 * @throws ReflectionException
2537
+	 * @throws InvalidDataTypeException
2538
+	 * @throws InvalidInterfaceException
2539
+	 */
2540
+	protected function _set_message_template_group()
2541
+	{
2542
+
2543
+		if (! empty($this->_message_template_group)) {
2544
+			return;
2545
+		} //get out if this is already set.
2546
+
2547
+		$GRP_ID = ! empty($this->_req_data['GRP_ID']) ? absint($this->_req_data['GRP_ID']) : false;
2548
+		$GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['id']) ? $this->_req_data['id'] : $GRP_ID;
2549
+
2550
+		// let's get the message templates
2551
+		$MTP = EEM_Message_Template_Group::instance();
2552
+
2553
+		if (empty($GRP_ID)) {
2554
+			$this->_message_template_group = $MTP->create_default_object();
2555
+		} else {
2556
+			$this->_message_template_group = $MTP->get_one_by_ID($GRP_ID);
2557
+		}
2558
+
2559
+		$this->_template_pack = $this->_message_template_group->get_template_pack();
2560
+		$this->_variation = $this->_message_template_group->get_template_pack_variation();
2561
+	}
2562
+
2563
+
2564
+	/**
2565
+	 * sets up a context switcher for edit forms
2566
+	 *
2567
+	 * @access  protected
2568
+	 * @param  EE_Message_Template_Group $template_group_object the template group object being displayed on the form
2569
+	 * @param array                      $args                  various things the context switcher needs.
2570
+	 * @throws EE_Error
2571
+	 */
2572
+	protected function _set_context_switcher(EE_Message_Template_Group $template_group_object, $args)
2573
+	{
2574
+		$context_details = $template_group_object->contexts_config();
2575
+		$context_label = $template_group_object->context_label();
2576
+		ob_start();
2577
+		?>
2578 2578
         <div class="ee-msg-switcher-container">
2579 2579
             <form method="get" action="<?php echo EE_MSG_ADMIN_URL; ?>" id="ee-msg-context-switcher-frm">
2580 2580
                 <?php
2581
-                foreach ($args as $name => $value) {
2582
-                    if ($name === 'context' || empty($value) || $name === 'extra') {
2583
-                        continue;
2584
-                    }
2585
-                    ?>
2581
+				foreach ($args as $name => $value) {
2582
+					if ($name === 'context' || empty($value) || $name === 'extra') {
2583
+						continue;
2584
+					}
2585
+					?>
2586 2586
                     <input type="hidden" name="<?php echo $name; ?>" value="<?php echo $value; ?>"/>
2587 2587
                     <?php
2588
-                }
2589
-                // setup nonce_url
2590
-                wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
2591
-                ?>
2588
+				}
2589
+				// setup nonce_url
2590
+				wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
2591
+				?>
2592 2592
                 <select name="context">
2593 2593
                     <?php
2594
-                    $context_templates = $template_group_object->context_templates();
2595
-                    if (is_array($context_templates)) :
2596
-                        foreach ($context_templates as $context => $template_fields) :
2597
-                            $checked = ($context === $args['context']) ? 'selected="selected"' : '';
2598
-                            ?>
2594
+					$context_templates = $template_group_object->context_templates();
2595
+					if (is_array($context_templates)) :
2596
+						foreach ($context_templates as $context => $template_fields) :
2597
+							$checked = ($context === $args['context']) ? 'selected="selected"' : '';
2598
+							?>
2599 2599
                             <option value="<?php echo $context; ?>" <?php echo $checked; ?>>
2600 2600
                                 <?php echo $context_details[ $context ]['label']; ?>
2601 2601
                             </option>
2602 2602
                         <?php endforeach;
2603
-                    endif; ?>
2603
+					endif; ?>
2604 2604
                 </select>
2605 2605
                 <?php $button_text = sprintf(__('Switch %s', 'event_espresso'), ucwords($context_label['label'])); ?>
2606 2606
                 <input id="submit-msg-context-switcher-sbmt" class="button-secondary" type="submit"
@@ -2609,1921 +2609,1921 @@  discard block
 block discarded – undo
2609 2609
             <?php echo $args['extra']; ?>
2610 2610
         </div> <!-- end .ee-msg-switcher-container -->
2611 2611
         <?php
2612
-        $output = ob_get_contents();
2613
-        ob_clean();
2614
-        $this->_context_switcher = $output;
2615
-    }
2616
-
2617
-
2618
-    /**
2619
-     * utility for sanitizing new values coming in.
2620
-     * Note: this is only used when updating a context.
2621
-     *
2622
-     * @access protected
2623
-     *
2624
-     * @param int $index This helps us know which template field to select from the request array.
2625
-     *
2626
-     * @return array
2627
-     */
2628
-    protected function _set_message_template_column_values($index)
2629
-    {
2630
-        if (is_array($this->_req_data['MTP_template_fields'][ $index ]['content'])) {
2631
-            foreach ($this->_req_data['MTP_template_fields'][ $index ]['content'] as $field => $value) {
2632
-                $this->_req_data['MTP_template_fields'][ $index ]['content'][ $field ] = $value;
2633
-            }
2634
-        }
2635
-
2636
-
2637
-        $set_column_values = array(
2638
-            'MTP_ID'             => absint($this->_req_data['MTP_template_fields'][ $index ]['MTP_ID']),
2639
-            'GRP_ID'             => absint($this->_req_data['GRP_ID']),
2640
-            'MTP_user_id'        => absint($this->_req_data['MTP_user_id']),
2641
-            'MTP_messenger'      => strtolower($this->_req_data['MTP_messenger']),
2642
-            'MTP_message_type'   => strtolower($this->_req_data['MTP_message_type']),
2643
-            'MTP_template_field' => strtolower($this->_req_data['MTP_template_fields'][ $index ]['name']),
2644
-            'MTP_context'        => strtolower($this->_req_data['MTP_context']),
2645
-            'MTP_content'        => $this->_req_data['MTP_template_fields'][ $index ]['content'],
2646
-            'MTP_is_global'      => isset($this->_req_data['MTP_is_global'])
2647
-                ? absint($this->_req_data['MTP_is_global'])
2648
-                : 0,
2649
-            'MTP_is_override'    => isset($this->_req_data['MTP_is_override'])
2650
-                ? absint($this->_req_data['MTP_is_override'])
2651
-                : 0,
2652
-            'MTP_deleted'        => absint($this->_req_data['MTP_deleted']),
2653
-            'MTP_is_active'      => absint($this->_req_data['MTP_is_active']),
2654
-        );
2655
-
2656
-
2657
-        return $set_column_values;
2658
-    }
2659
-
2660
-
2661
-    protected function _insert_or_update_message_template($new = false)
2662
-    {
2663
-
2664
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2665
-        $success = 0;
2666
-        $override = false;
2667
-
2668
-        // setup notices description
2669
-        $messenger_slug = ! empty($this->_req_data['MTP_messenger']) ? $this->_req_data['MTP_messenger'] : '';
2670
-
2671
-        // need the message type and messenger objects to be able to use the labels for the notices
2672
-        $messenger_object = $this->_message_resource_manager->get_messenger($messenger_slug);
2673
-        $messenger_label = $messenger_object instanceof EE_messenger
2674
-            ? ucwords($messenger_object->label['singular'])
2675
-            : '';
2676
-
2677
-        $message_type_slug = ! empty($this->_req_data['MTP_message_type'])
2678
-            ? $this->_req_data['MTP_message_type']
2679
-            : '';
2680
-        $message_type_object = $this->_message_resource_manager->get_message_type($message_type_slug);
2681
-
2682
-        $message_type_label = $message_type_object instanceof EE_message_type
2683
-            ? ucwords($message_type_object->label['singular'])
2684
-            : '';
2685
-
2686
-        $context_slug = ! empty($this->_req_data['MTP_context'])
2687
-            ? $this->_req_data['MTP_context']
2688
-            : '';
2689
-        $context = ucwords(str_replace('_', ' ', $context_slug));
2690
-
2691
-        $item_desc = $messenger_label && $message_type_label
2692
-            ? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' '
2693
-            : '';
2694
-        $item_desc .= 'Message Template';
2695
-        $query_args = array();
2696
-        $edit_array = array();
2697
-        $action_desc = '';
2698
-
2699
-        // if this is "new" then we need to generate the default contexts for the selected messenger/message_type for
2700
-        // user to edit.
2701
-        if ($new) {
2702
-            $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
2703
-            if ($edit_array = $this->_generate_new_templates($messenger_slug, $message_type_slug, $GRP_ID)) {
2704
-                if (empty($edit_array)) {
2705
-                    $success = 0;
2706
-                } else {
2707
-                    $success = 1;
2708
-                    $edit_array = $edit_array[0];
2709
-                    $query_args = array(
2710
-                        'id'      => $edit_array['GRP_ID'],
2711
-                        'context' => $edit_array['MTP_context'],
2712
-                        'action'  => 'edit_message_template',
2713
-                    );
2714
-                }
2715
-            }
2716
-            $action_desc = 'created';
2717
-        } else {
2718
-            $MTPG = EEM_Message_Template_Group::instance();
2719
-            $MTP = EEM_Message_Template::instance();
2720
-
2721
-
2722
-            // run update for each template field in displayed context
2723
-            if (! isset($this->_req_data['MTP_template_fields']) && empty($this->_req_data['MTP_template_fields'])) {
2724
-                EE_Error::add_error(
2725
-                    esc_html__(
2726
-                        'There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
2727
-                        'event_espresso'
2728
-                    ),
2729
-                    __FILE__,
2730
-                    __FUNCTION__,
2731
-                    __LINE__
2732
-                );
2733
-                $success = 0;
2734
-            } else {
2735
-                // first validate all fields!
2736
-                // this filter allows client code to add its own validation to the template fields as well.
2737
-                // returning an empty array means everything passed validation.
2738
-                // errors in validation should be represented in an array with the following shape:
2739
-                // array(
2740
-                //   'fieldname' => array(
2741
-                //          'msg' => 'error message'
2742
-                //          'value' => 'value for field producing error'
2743
-                // )
2744
-                $custom_validation = (array) apply_filters(
2745
-                    'FHEE__Messages_Admin_Page___insert_or_update_message_template__validates',
2746
-                    array(),
2747
-                    $this->_req_data['MTP_template_fields'],
2748
-                    $context_slug,
2749
-                    $messenger_slug,
2750
-                    $message_type_slug
2751
-                );
2752
-
2753
-                $system_validation = $MTPG->validate(
2754
-                    $this->_req_data['MTP_template_fields'],
2755
-                    $context_slug,
2756
-                    $messenger_slug,
2757
-                    $message_type_slug
2758
-                );
2759
-
2760
-                $system_validation = ! is_array($system_validation) && $system_validation ? array()
2761
-                    : $system_validation;
2762
-                $validates = array_merge($custom_validation, $system_validation);
2763
-
2764
-                // if $validate returned error messages (i.e. is_array()) then we need to process them and setup an
2765
-                // appropriate response. HMM, dang this isn't correct, $validates will ALWAYS be an array.
2766
-                //  WE need to make sure there is no actual error messages in validates.
2767
-                if (is_array($validates) && ! empty($validates)) {
2768
-                    // add the transient so when the form loads we know which fields to highlight
2769
-                    $this->_add_transient('edit_message_template', $validates);
2770
-
2771
-                    $success = 0;
2772
-
2773
-                    // setup notices
2774
-                    foreach ($validates as $field => $error) {
2775
-                        if (isset($error['msg'])) {
2776
-                            EE_Error::add_error($error['msg'], __FILE__, __FUNCTION__, __LINE__);
2777
-                        }
2778
-                    }
2779
-                } else {
2780
-                    $set_column_values = array();
2781
-                    foreach ($this->_req_data['MTP_template_fields'] as $template_field => $content) {
2782
-                        $set_column_values = $this->_set_message_template_column_values($template_field);
2783
-
2784
-                        $where_cols_n_values = array(
2785
-                            'MTP_ID' => $this->_req_data['MTP_template_fields'][ $template_field ]['MTP_ID'],
2786
-                        );
2787
-                        // if they aren't allowed to use all JS, restrict them to just posty-y tags
2788
-                        if (! current_user_can('unfiltered_html')) {
2789
-                            if (is_array($set_column_values['MTP_content'])) {
2790
-                                foreach ($set_column_values['MTP_content'] as $key => $value) {
2791
-                                    // remove slashes so wp_kses works properly (its wp_kses_stripslashes() function
2792
-                                    // only removes slashes from double-quotes, so attributes using single quotes always
2793
-                                    // appear invalid.) But currently the models expect slashed data, so after wp_kses
2794
-                                    // runs we need to re-slash the data. Sheesh. See
2795
-                                    // https://events.codebasehq.com/projects/event-espresso/tickets/11211#update-47321587
2796
-                                    $set_column_values['MTP_content'][ $key ] = addslashes(
2797
-                                        wp_kses(
2798
-                                            stripslashes($value),
2799
-                                            wp_kses_allowed_html('post')
2800
-                                        )
2801
-                                    );
2802
-                                }
2803
-                            } else {
2804
-                                $set_column_values['MTP_content'] = wp_kses(
2805
-                                    $set_column_values['MTP_content'],
2806
-                                    wp_kses_allowed_html('post')
2807
-                                );
2808
-                            }
2809
-                        }
2810
-                        $message_template_fields = array(
2811
-                            'GRP_ID'             => $set_column_values['GRP_ID'],
2812
-                            'MTP_template_field' => $set_column_values['MTP_template_field'],
2813
-                            'MTP_context'        => $set_column_values['MTP_context'],
2814
-                            'MTP_content'        => $set_column_values['MTP_content'],
2815
-                        );
2816
-                        if ($updated = $MTP->update($message_template_fields, array($where_cols_n_values))) {
2817
-                            if ($updated === false) {
2818
-                                EE_Error::add_error(
2819
-                                    sprintf(
2820
-                                        esc_html__('%s field was NOT updated for some reason', 'event_espresso'),
2821
-                                        $template_field
2822
-                                    ),
2823
-                                    __FILE__,
2824
-                                    __FUNCTION__,
2825
-                                    __LINE__
2826
-                                );
2827
-                            } else {
2828
-                                $success = 1;
2829
-                            }
2830
-                        } else {
2831
-                            // only do this logic if we don't have a MTP_ID for this field
2832
-                            if (empty($this->_req_data['MTP_template_fields'][ $template_field ]['MTP_ID'])) {
2833
-                                // this has already been through the template field validator and sanitized, so it will be
2834
-                                // safe to insert this field.  Why insert?  This typically happens when we introduce a new
2835
-                                // message template field in a messenger/message type and existing users don't have the
2836
-                                // default setup for it.
2837
-                                // @link https://events.codebasehq.com/projects/event-espresso/tickets/9465
2838
-                                $updated = $MTP->insert($message_template_fields);
2839
-                                if (! $updated || is_wp_error($updated)) {
2840
-                                    EE_Error::add_error(
2841
-                                        sprintf(
2842
-                                            esc_html__('%s field could not be updated.', 'event_espresso'),
2843
-                                            $template_field
2844
-                                        ),
2845
-                                        __FILE__,
2846
-                                        __FUNCTION__,
2847
-                                        __LINE__
2848
-                                    );
2849
-                                    $success = 0;
2850
-                                } else {
2851
-                                    $success = 1;
2852
-                                }
2853
-                            }
2854
-                        }
2855
-                        $action_desc = 'updated';
2856
-                    }
2857
-
2858
-                    // we can use the last set_column_values for the MTPG update (because its the same for all of these specific MTPs)
2859
-                    $mtpg_fields = array(
2860
-                        'MTP_user_id'      => $set_column_values['MTP_user_id'],
2861
-                        'MTP_messenger'    => $set_column_values['MTP_messenger'],
2862
-                        'MTP_message_type' => $set_column_values['MTP_message_type'],
2863
-                        'MTP_is_global'    => $set_column_values['MTP_is_global'],
2864
-                        'MTP_is_override'  => $set_column_values['MTP_is_override'],
2865
-                        'MTP_deleted'      => $set_column_values['MTP_deleted'],
2866
-                        'MTP_is_active'    => $set_column_values['MTP_is_active'],
2867
-                        'MTP_name'         => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_name'])
2868
-                            ? $this->_req_data['ee_msg_non_global_fields']['MTP_name']
2869
-                            : '',
2870
-                        'MTP_description'  => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_description'])
2871
-                            ? $this->_req_data['ee_msg_non_global_fields']['MTP_description']
2872
-                            : '',
2873
-                    );
2874
-
2875
-                    $mtpg_where = array('GRP_ID' => $set_column_values['GRP_ID']);
2876
-                    $updated = $MTPG->update($mtpg_fields, array($mtpg_where));
2877
-
2878
-                    if ($updated === false) {
2879
-                        EE_Error::add_error(
2880
-                            sprintf(
2881
-                                esc_html__(
2882
-                                    'The Message Template Group (%d) was NOT updated for some reason',
2883
-                                    'event_espresso'
2884
-                                ),
2885
-                                $set_column_values['GRP_ID']
2886
-                            ),
2887
-                            __FILE__,
2888
-                            __FUNCTION__,
2889
-                            __LINE__
2890
-                        );
2891
-                    } else {
2892
-                        // k now we need to ensure the template_pack and template_variation fields are set.
2893
-                        $template_pack = ! empty($this->_req_data['MTP_template_pack'])
2894
-                            ? $this->_req_data['MTP_template_pack']
2895
-                            : 'default';
2896
-
2897
-                        $template_variation = ! empty($this->_req_data['MTP_template_variation'])
2898
-                            ? $this->_req_data['MTP_template_variation']
2899
-                            : 'default';
2900
-
2901
-                        $mtpg_obj = $MTPG->get_one_by_ID($set_column_values['GRP_ID']);
2902
-                        if ($mtpg_obj instanceof EE_Message_Template_Group) {
2903
-                            $mtpg_obj->set_template_pack_name($template_pack);
2904
-                            $mtpg_obj->set_template_pack_variation($template_variation);
2905
-                        }
2906
-                        $success = 1;
2907
-                    }
2908
-                }
2909
-            }
2910
-        }
2911
-
2912
-        // we return things differently if doing ajax
2913
-        if (defined('DOING_AJAX') && DOING_AJAX) {
2914
-            $this->_template_args['success'] = $success;
2915
-            $this->_template_args['error'] = ! $success ? true : false;
2916
-            $this->_template_args['content'] = '';
2917
-            $this->_template_args['data'] = array(
2918
-                'grpID'        => $edit_array['GRP_ID'],
2919
-                'templateName' => $edit_array['template_name'],
2920
-            );
2921
-            if ($success) {
2922
-                EE_Error::overwrite_success();
2923
-                EE_Error::add_success(
2924
-                    esc_html__(
2925
-                        '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.',
2926
-                        'event_espresso'
2927
-                    )
2928
-                );
2929
-            }
2930
-
2931
-            $this->_return_json();
2932
-        }
2933
-
2934
-
2935
-        // was a test send triggered?
2936
-        if (isset($this->_req_data['test_button'])) {
2937
-            EE_Error::overwrite_success();
2938
-            $this->_do_test_send($context_slug, $messenger_slug, $message_type_slug);
2939
-            $override = true;
2940
-        }
2941
-
2942
-        if (empty($query_args)) {
2943
-            $query_args = array(
2944
-                'id'      => $this->_req_data['GRP_ID'],
2945
-                'context' => $context_slug,
2946
-                'action'  => 'edit_message_template',
2947
-            );
2948
-        }
2949
-
2950
-        $this->_redirect_after_action($success, $item_desc, $action_desc, $query_args, $override);
2951
-    }
2952
-
2953
-
2954
-    /**
2955
-     * processes a test send request to do an actual messenger delivery test for the given message template being tested
2956
-     *
2957
-     * @param  string $context      what context being tested
2958
-     * @param  string $messenger    messenger being tested
2959
-     * @param  string $message_type message type being tested
2960
-     * @throws EE_Error
2961
-     * @throws InvalidArgumentException
2962
-     * @throws InvalidDataTypeException
2963
-     * @throws InvalidInterfaceException
2964
-     */
2965
-    protected function _do_test_send($context, $messenger, $message_type)
2966
-    {
2967
-        // set things up for preview
2968
-        $this->_req_data['messenger'] = $messenger;
2969
-        $this->_req_data['message_type'] = $message_type;
2970
-        $this->_req_data['context'] = $context;
2971
-        $this->_req_data['GRP_ID'] = isset($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : '';
2972
-        $active_messenger = $this->_message_resource_manager->get_active_messenger($messenger);
2973
-
2974
-        // let's save any existing fields that might be required by the messenger
2975
-        if (isset($this->_req_data['test_settings_fld'])
2976
-            && $active_messenger instanceof EE_messenger
2977
-            && apply_filters(
2978
-                'FHEE__Messages_Admin_Page__do_test_send__set_existing_test_settings',
2979
-                true,
2980
-                $this->_req_data['test_settings_fld'],
2981
-                $active_messenger
2982
-            )
2983
-        ) {
2984
-            $active_messenger->set_existing_test_settings($this->_req_data['test_settings_fld']);
2985
-        }
2986
-
2987
-        /**
2988
-         * Use filter to add additional controls on whether message can send or not
2989
-         */
2990
-        if (apply_filters(
2991
-            'FHEE__Messages_Admin_Page__do_test_send__can_send',
2992
-            true,
2993
-            $context,
2994
-            $this->_req_data,
2995
-            $messenger,
2996
-            $message_type
2997
-        )) {
2998
-            $success = $this->_preview_message(true);
2999
-            if ($success) {
3000
-                EE_Error::add_success(__('Test message sent', 'event_espresso'));
3001
-            } else {
3002
-                EE_Error::add_error(
3003
-                    esc_html__('The test message was not sent', 'event_espresso'),
3004
-                    __FILE__,
3005
-                    __FUNCTION__,
3006
-                    __LINE__
3007
-                );
3008
-            }
3009
-        }
3010
-    }
3011
-
3012
-
3013
-    /**
3014
-     * _generate_new_templates
3015
-     * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will
3016
-     * automatically create the defaults for the event.  The user would then be redirected to edit the default context
3017
-     * for the event.
3018
-     *
3019
-     *
3020
-     * @param  string $messenger     the messenger we are generating templates for
3021
-     * @param array   $message_types array of message types that the templates are generated for.
3022
-     * @param int     $GRP_ID        If this is a custom template being generated then a GRP_ID needs to be included to
3023
-     *                               indicate the message_template_group being used as the base.
3024
-     *
3025
-     * @param bool    $global
3026
-     *
3027
-     * @return array|bool array of data required for the redirect to the correct edit page or bool if
3028
-     *                               encountering problems.
3029
-     * @throws EE_Error
3030
-     */
3031
-    protected function _generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
3032
-    {
3033
-
3034
-        // if no $message_types are given then that's okay... this may be a messenger that just adds shortcodes, so we
3035
-        // just don't generate any templates.
3036
-        if (empty($message_types)) {
3037
-            return true;
3038
-        }
3039
-
3040
-        return EEH_MSG_Template::generate_new_templates($messenger, $message_types, $GRP_ID, $global);
3041
-    }
3042
-
3043
-
3044
-    /**
3045
-     * [_trash_or_restore_message_template]
3046
-     *
3047
-     * @param  boolean $trash whether to move an item to trash/restore (TRUE) or restore it (FALSE)
3048
-     * @param boolean  $all   whether this is going to trash/restore all contexts within a template group (TRUE) OR just
3049
-     *                        an individual context (FALSE).
3050
-     * @return void
3051
-     * @throws EE_Error
3052
-     * @throws InvalidArgumentException
3053
-     * @throws InvalidDataTypeException
3054
-     * @throws InvalidInterfaceException
3055
-     */
3056
-    protected function _trash_or_restore_message_template($trash = true, $all = false)
3057
-    {
3058
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
3059
-        $MTP = EEM_Message_Template_Group::instance();
3060
-
3061
-        $success = 1;
3062
-
3063
-        // incoming GRP_IDs
3064
-        if ($all) {
3065
-            // Checkboxes
3066
-            if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
3067
-                // if array has more than one element then success message should be plural.
3068
-                // todo: what about nonce?
3069
-                $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
3070
-
3071
-                // cycle through checkboxes
3072
-                while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
3073
-                    $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
3074
-                    if (! $trashed_or_restored) {
3075
-                        $success = 0;
3076
-                    }
3077
-                }
3078
-            } else {
3079
-                // grab single GRP_ID and handle
3080
-                $GRP_ID = isset($this->_req_data['id']) ? absint($this->_req_data['id']) : 0;
3081
-                if (! empty($GRP_ID)) {
3082
-                    $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
3083
-                    if (! $trashed_or_restored) {
3084
-                        $success = 0;
3085
-                    }
3086
-                } else {
3087
-                    $success = 0;
3088
-                }
3089
-            }
3090
-        }
3091
-
3092
-        $action_desc = $trash
3093
-            ? esc_html__('moved to the trash', 'event_espresso')
3094
-            : esc_html__('restored', 'event_espresso');
3095
-
3096
-        $action_desc = ! empty($this->_req_data['template_switch']) ? esc_html__('switched', 'event_espresso') : $action_desc;
3097
-
3098
-        $item_desc = $all ? _n(
3099
-            'Message Template Group',
3100
-            'Message Template Groups',
3101
-            $success,
3102
-            'event_espresso'
3103
-        ) : _n('Message Template Context', 'Message Template Contexts', $success, 'event_espresso');
3104
-
3105
-        $item_desc = ! empty($this->_req_data['template_switch']) ? _n(
3106
-            'template',
3107
-            'templates',
3108
-            $success,
3109
-            'event_espresso'
3110
-        ) : $item_desc;
3111
-
3112
-        $this->_redirect_after_action($success, $item_desc, $action_desc, array());
3113
-    }
3114
-
3115
-
3116
-    /**
3117
-     * [_delete_message_template]
3118
-     * NOTE: this handles not only the deletion of the groups but also all the templates belonging to that group.
3119
-     *
3120
-     * @return void
3121
-     * @throws EE_Error
3122
-     * @throws InvalidArgumentException
3123
-     * @throws InvalidDataTypeException
3124
-     * @throws InvalidInterfaceException
3125
-     */
3126
-    protected function _delete_message_template()
3127
-    {
3128
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
3129
-
3130
-        // checkboxes
3131
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
3132
-            // if array has more than one element then success message should be plural
3133
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
3134
-
3135
-            // cycle through bulk action checkboxes
3136
-            while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
3137
-                $success = $this->_delete_mtp_permanently($GRP_ID);
3138
-            }
3139
-        } else {
3140
-            // grab single grp_id and delete
3141
-            $GRP_ID = absint($this->_req_data['id']);
3142
-            $success = $this->_delete_mtp_permanently($GRP_ID);
3143
-        }
3144
-
3145
-        $this->_redirect_after_action($success, 'Message Templates', 'deleted', array());
3146
-    }
3147
-
3148
-
3149
-    /**
3150
-     * helper for permanently deleting a mtP group and all related message_templates
3151
-     *
3152
-     * @param  int  $GRP_ID        The group being deleted
3153
-     * @param  bool $include_group whether to delete the Message Template Group as well.
3154
-     * @return bool boolean to indicate the success of the deletes or not.
3155
-     * @throws EE_Error
3156
-     * @throws InvalidArgumentException
3157
-     * @throws InvalidDataTypeException
3158
-     * @throws InvalidInterfaceException
3159
-     */
3160
-    private function _delete_mtp_permanently($GRP_ID, $include_group = true)
3161
-    {
3162
-        $success = 1;
3163
-        $MTPG = EEM_Message_Template_Group::instance();
3164
-        // first let's GET this group
3165
-        $MTG = $MTPG->get_one_by_ID($GRP_ID);
3166
-        // then delete permanently all the related Message Templates
3167
-        $deleted = $MTG->delete_related_permanently('Message_Template');
3168
-
3169
-        if ($deleted === 0) {
3170
-            $success = 0;
3171
-        }
3172
-
3173
-        // now delete permanently this particular group
3174
-
3175
-        if ($include_group && ! $MTG->delete_permanently()) {
3176
-            $success = 0;
3177
-        }
3178
-
3179
-        return $success;
3180
-    }
3181
-
3182
-
3183
-    /**
3184
-     *    _learn_more_about_message_templates_link
3185
-     *
3186
-     * @access protected
3187
-     * @return string
3188
-     */
3189
-    protected function _learn_more_about_message_templates_link()
3190
-    {
3191
-        return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >'
3192
-               . esc_html__('learn more about how message templates works', 'event_espresso')
3193
-               . '</a>';
3194
-    }
3195
-
3196
-
3197
-    /**
3198
-     * Used for setting up messenger/message type activation.  This loads up the initial view.  The rest is handled by
3199
-     * ajax and other routes.
3200
-     *
3201
-     * @return void
3202
-     * @throws DomainException
3203
-     */
3204
-    protected function _settings()
3205
-    {
3206
-
3207
-
3208
-        $this->_set_m_mt_settings();
3209
-
3210
-        $selected_messenger = isset($this->_req_data['selected_messenger'])
3211
-            ? $this->_req_data['selected_messenger']
3212
-            : 'email';
3213
-
3214
-        // let's setup the messenger tabs
3215
-        $this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
3216
-            $this->_m_mt_settings['messenger_tabs'],
3217
-            'messenger_links',
3218
-            '|',
3219
-            $selected_messenger
3220
-        );
3221
-        $this->_template_args['before_admin_page_content'] = '<div class="ui-widget ui-helper-clearfix">';
3222
-        $this->_template_args['after_admin_page_content'] = '</div><!-- end .ui-widget -->';
3223
-
3224
-        $this->display_admin_page_with_sidebar();
3225
-    }
3226
-
3227
-
3228
-    /**
3229
-     * This sets the $_m_mt_settings property for when needed (used on the Messages settings page)
3230
-     *
3231
-     * @access protected
3232
-     * @return void
3233
-     * @throws DomainException
3234
-     */
3235
-    protected function _set_m_mt_settings()
3236
-    {
3237
-        // first if this is already set then lets get out no need to regenerate data.
3238
-        if (! empty($this->_m_mt_settings)) {
3239
-            return;
3240
-        }
3241
-
3242
-        // get all installed messengers and message_types
3243
-        /** @type EE_messenger[] $messengers */
3244
-        $messengers = $this->_message_resource_manager->installed_messengers();
3245
-        /** @type EE_message_type[] $message_types */
3246
-        $message_types = $this->_message_resource_manager->installed_message_types();
3247
-
3248
-
3249
-        // assemble the array for the _tab_text_links helper
3250
-
3251
-        foreach ($messengers as $messenger) {
3252
-            $this->_m_mt_settings['messenger_tabs'][ $messenger->name ] = array(
3253
-                'label' => ucwords($messenger->label['singular']),
3254
-                'class' => $this->_message_resource_manager->is_messenger_active($messenger->name)
3255
-                    ? 'messenger-active'
3256
-                    : '',
3257
-                'href'  => $messenger->name,
3258
-                'title' => esc_html__('Modify this Messenger', 'event_espresso'),
3259
-                'slug'  => $messenger->name,
3260
-                'obj'   => $messenger,
3261
-            );
3262
-
3263
-
3264
-            $message_types_for_messenger = $messenger->get_valid_message_types();
3265
-
3266
-            foreach ($message_types as $message_type) {
3267
-                // first we need to verify that this message type is valid with this messenger. Cause if it isn't then
3268
-                // it shouldn't show in either the inactive OR active metabox.
3269
-                if (! in_array($message_type->name, $message_types_for_messenger, true)) {
3270
-                    continue;
3271
-                }
3272
-
3273
-                $a_or_i = $this->_message_resource_manager->is_message_type_active_for_messenger(
3274
-                    $messenger->name,
3275
-                    $message_type->name
3276
-                )
3277
-                    ? 'active'
3278
-                    : 'inactive';
3279
-
3280
-                $this->_m_mt_settings['message_type_tabs'][ $messenger->name ][ $a_or_i ][ $message_type->name ] = array(
3281
-                    'label'    => ucwords($message_type->label['singular']),
3282
-                    'class'    => 'message-type-' . $a_or_i,
3283
-                    'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
3284
-                    'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
3285
-                    'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
3286
-                    'title'    => $a_or_i === 'active'
3287
-                        ? esc_html__('Drag this message type to the Inactive window to deactivate', 'event_espresso')
3288
-                        : esc_html__('Drag this message type to the messenger to activate', 'event_espresso'),
3289
-                    'content'  => $a_or_i === 'active'
3290
-                        ? $this->_message_type_settings_content($message_type, $messenger, true)
3291
-                        : $this->_message_type_settings_content($message_type, $messenger),
3292
-                    'slug'     => $message_type->name,
3293
-                    'active'   => $a_or_i === 'active',
3294
-                    'obj'      => $message_type,
3295
-                );
3296
-            }
3297
-        }
3298
-    }
3299
-
3300
-
3301
-    /**
3302
-     * This just prepares the content for the message type settings
3303
-     *
3304
-     * @param  EE_message_type $message_type The message type object
3305
-     * @param  EE_messenger    $messenger    The messenger object
3306
-     * @param  boolean         $active       Whether the message type is active or not
3307
-     * @return string html output for the content
3308
-     * @throws DomainException
3309
-     */
3310
-    protected function _message_type_settings_content($message_type, $messenger, $active = false)
3311
-    {
3312
-        // get message type fields
3313
-        $fields = $message_type->get_admin_settings_fields();
3314
-        $settings_template_args['template_form_fields'] = '';
3315
-
3316
-        if (! empty($fields) && $active) {
3317
-            $existing_settings = $message_type->get_existing_admin_settings($messenger->name);
3318
-            foreach ($fields as $fldname => $fldprops) {
3319
-                $field_id = $messenger->name . '-' . $message_type->name . '-' . $fldname;
3320
-                $template_form_field[ $field_id ] = array(
3321
-                    'name'       => 'message_type_settings[' . $fldname . ']',
3322
-                    'label'      => $fldprops['label'],
3323
-                    'input'      => $fldprops['field_type'],
3324
-                    'type'       => $fldprops['value_type'],
3325
-                    'required'   => $fldprops['required'],
3326
-                    'validation' => $fldprops['validation'],
3327
-                    'value'      => isset($existing_settings[ $fldname ])
3328
-                        ? $existing_settings[ $fldname ]
3329
-                        : $fldprops['default'],
3330
-                    'options'    => isset($fldprops['options'])
3331
-                        ? $fldprops['options']
3332
-                        : array(),
3333
-                    'default'    => isset($existing_settings[ $fldname ])
3334
-                        ? $existing_settings[ $fldname ]
3335
-                        : $fldprops['default'],
3336
-                    'css_class'  => 'no-drag',
3337
-                    'format'     => $fldprops['format'],
3338
-                );
3339
-            }
3340
-
3341
-
3342
-            $settings_template_args['template_form_fields'] = ! empty($template_form_field)
3343
-                ? $this->_generate_admin_form_fields(
3344
-                    $template_form_field,
3345
-                    'string',
3346
-                    'ee_mt_activate_form'
3347
-                )
3348
-                : '';
3349
-        }
3350
-
3351
-        $settings_template_args['description'] = $message_type->description;
3352
-        // we also need some hidden fields
3353
-        $settings_template_args['hidden_fields'] = array(
3354
-            'message_type_settings[messenger]'    => array(
3355
-                'type'  => 'hidden',
3356
-                'value' => $messenger->name,
3357
-            ),
3358
-            'message_type_settings[message_type]' => array(
3359
-                'type'  => 'hidden',
3360
-                'value' => $message_type->name,
3361
-            ),
3362
-            'type'                                => array(
3363
-                'type'  => 'hidden',
3364
-                'value' => 'message_type',
3365
-            ),
3366
-        );
3367
-
3368
-        $settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
3369
-            $settings_template_args['hidden_fields'],
3370
-            'array'
3371
-        );
3372
-        $settings_template_args['show_form'] = empty($settings_template_args['template_form_fields'])
3373
-            ? ' hidden'
3374
-            : '';
3375
-
3376
-
3377
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
3378
-        $content = EEH_Template::display_template($template, $settings_template_args, true);
3379
-
3380
-        return $content;
3381
-    }
3382
-
3383
-
3384
-    /**
3385
-     * Generate all the metaboxes for the message types and register them for the messages settings page.
3386
-     *
3387
-     * @access protected
3388
-     * @return void
3389
-     * @throws DomainException
3390
-     */
3391
-    protected function _messages_settings_metaboxes()
3392
-    {
3393
-        $this->_set_m_mt_settings();
3394
-        $m_boxes = $mt_boxes = array();
3395
-        $m_template_args = $mt_template_args = array();
3396
-
3397
-        $selected_messenger = isset($this->_req_data['selected_messenger'])
3398
-            ? $this->_req_data['selected_messenger']
3399
-            : 'email';
3400
-
3401
-        if (isset($this->_m_mt_settings['messenger_tabs'])) {
3402
-            foreach ($this->_m_mt_settings['messenger_tabs'] as $messenger => $tab_array) {
3403
-                $hide_on_message = $this->_message_resource_manager->is_messenger_active($messenger) ? '' : 'hidden';
3404
-                $hide_off_message = $this->_message_resource_manager->is_messenger_active($messenger) ? 'hidden' : '';
3405
-                // messenger meta boxes
3406
-                $active = $selected_messenger === $messenger;
3407
-                $active_mt_tabs = isset(
3408
-                    $this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
3409
-                )
3410
-                    ? $this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
3411
-                    : '';
3412
-                $m_boxes[ $messenger . '_a_box' ] = sprintf(
3413
-                    esc_html__('%s Settings', 'event_espresso'),
3414
-                    $tab_array['label']
3415
-                );
3416
-                $m_template_args[ $messenger . '_a_box' ] = array(
3417
-                    'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
3418
-                    'inactive_message_types' => isset(
3419
-                        $this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
3420
-                    )
3421
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
3422
-                        : '',
3423
-                    'content'                => $this->_get_messenger_box_content($tab_array['obj']),
3424
-                    'hidden'                 => $active ? '' : ' hidden',
3425
-                    'hide_on_message'        => $hide_on_message,
3426
-                    'messenger'              => $messenger,
3427
-                    'active'                 => $active,
3428
-                );
3429
-                // message type meta boxes
3430
-                // (which is really just the inactive container for each messenger
3431
-                // showing inactive message types for that messenger)
3432
-                $mt_boxes[ $messenger . '_i_box' ] = esc_html__('Inactive Message Types', 'event_espresso');
3433
-                $mt_template_args[ $messenger . '_i_box' ] = array(
3434
-                    'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
3435
-                    'inactive_message_types' => isset(
3436
-                        $this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
3437
-                    )
3438
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
3439
-                        : '',
3440
-                    'hidden'                 => $active ? '' : ' hidden',
3441
-                    'hide_on_message'        => $hide_on_message,
3442
-                    'hide_off_message'       => $hide_off_message,
3443
-                    'messenger'              => $messenger,
3444
-                    'active'                 => $active,
3445
-                );
3446
-            }
3447
-        }
3448
-
3449
-
3450
-        // register messenger metaboxes
3451
-        $m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
3452
-        foreach ($m_boxes as $box => $label) {
3453
-            $callback_args = array('template_path' => $m_template_path, 'template_args' => $m_template_args[ $box ]);
3454
-            $msgr = str_replace('_a_box', '', $box);
3455
-            add_meta_box(
3456
-                'espresso_' . $msgr . '_settings',
3457
-                $label,
3458
-                function ($post, $metabox) {
3459
-                    echo EEH_Template::display_template(
3460
-                        $metabox["args"]["template_path"],
3461
-                        $metabox["args"]["template_args"],
3462
-                        true
3463
-                    );
3464
-                },
3465
-                $this->_current_screen->id,
3466
-                'normal',
3467
-                'high',
3468
-                $callback_args
3469
-            );
3470
-        }
3471
-
3472
-        // register message type metaboxes
3473
-        $mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
3474
-        foreach ($mt_boxes as $box => $label) {
3475
-            $callback_args = array(
3476
-                'template_path' => $mt_template_path,
3477
-                'template_args' => $mt_template_args[ $box ],
3478
-            );
3479
-            $mt = str_replace('_i_box', '', $box);
3480
-            add_meta_box(
3481
-                'espresso_' . $mt . '_inactive_mts',
3482
-                $label,
3483
-                function ($post, $metabox) {
3484
-                    echo EEH_Template::display_template(
3485
-                        $metabox["args"]["template_path"],
3486
-                        $metabox["args"]["template_args"],
3487
-                        true
3488
-                    );
3489
-                },
3490
-                $this->_current_screen->id,
3491
-                'side',
3492
-                'high',
3493
-                $callback_args
3494
-            );
3495
-        }
3496
-
3497
-        // register metabox for global messages settings but only when on the main site.  On single site installs this
3498
-        // will always result in the metabox showing, on multisite installs the metabox will only show on the main site.
3499
-        if (is_main_site()) {
3500
-            add_meta_box(
3501
-                'espresso_global_message_settings',
3502
-                esc_html__('Global Message Settings', 'event_espresso'),
3503
-                array($this, 'global_messages_settings_metabox_content'),
3504
-                $this->_current_screen->id,
3505
-                'normal',
3506
-                'low',
3507
-                array()
3508
-            );
3509
-        }
3510
-    }
3511
-
3512
-
3513
-    /**
3514
-     *  This generates the content for the global messages settings metabox.
3515
-     *
3516
-     * @return string
3517
-     * @throws EE_Error
3518
-     * @throws InvalidArgumentException
3519
-     * @throws ReflectionException
3520
-     * @throws InvalidDataTypeException
3521
-     * @throws InvalidInterfaceException
3522
-     */
3523
-    public function global_messages_settings_metabox_content()
3524
-    {
3525
-        $form = $this->_generate_global_settings_form();
3526
-        echo $form->form_open(
3527
-            $this->add_query_args_and_nonce(array('action' => 'update_global_settings'), EE_MSG_ADMIN_URL),
3528
-            'POST'
3529
-        )
3530
-             . $form->get_html()
3531
-             . $form->form_close();
3532
-    }
3533
-
3534
-
3535
-    /**
3536
-     * This generates and returns the form object for the global messages settings.
3537
-     *
3538
-     * @return EE_Form_Section_Proper
3539
-     * @throws EE_Error
3540
-     * @throws InvalidArgumentException
3541
-     * @throws ReflectionException
3542
-     * @throws InvalidDataTypeException
3543
-     * @throws InvalidInterfaceException
3544
-     */
3545
-    protected function _generate_global_settings_form()
3546
-    {
3547
-        EE_Registry::instance()->load_helper('HTML');
3548
-        /** @var EE_Network_Core_Config $network_config */
3549
-        $network_config = EE_Registry::instance()->NET_CFG->core;
3550
-
3551
-        return new EE_Form_Section_Proper(
3552
-            array(
3553
-                'name'            => 'global_messages_settings',
3554
-                'html_id'         => 'global_messages_settings',
3555
-                'html_class'      => 'form-table',
3556
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
3557
-                'subsections'     => apply_filters(
3558
-                    'FHEE__Messages_Admin_Page__global_messages_settings_metabox_content__form_subsections',
3559
-                    array(
3560
-                        'do_messages_on_same_request' => new EE_Select_Input(
3561
-                            array(
3562
-                                true  => esc_html__("On the same request", "event_espresso"),
3563
-                                false => esc_html__("On a separate request", "event_espresso"),
3564
-                            ),
3565
-                            array(
3566
-                                'default'         => $network_config->do_messages_on_same_request,
3567
-                                'html_label_text' => esc_html__(
3568
-                                    'Generate and send all messages:',
3569
-                                    'event_espresso'
3570
-                                ),
3571
-                                'html_help_text'  => esc_html__(
3572
-                                    '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.',
3573
-                                    'event_espresso'
3574
-                                ),
3575
-                            )
3576
-                        ),
3577
-                        'delete_threshold'            => new EE_Select_Input(
3578
-                            array(
3579
-                                0  => esc_html__('Forever', 'event_espresso'),
3580
-                                3  => esc_html__('3 Months', 'event_espresso'),
3581
-                                6  => esc_html__('6 Months', 'event_espresso'),
3582
-                                9  => esc_html__('9 Months', 'event_espresso'),
3583
-                                12 => esc_html__('12 Months', 'event_espresso'),
3584
-                                24 => esc_html__('24 Months', 'event_espresso'),
3585
-                                36 => esc_html__('36 Months', 'event_espresso'),
3586
-                            ),
3587
-                            array(
3588
-                                'default'         => EE_Registry::instance()->CFG->messages->delete_threshold,
3589
-                                'html_label_text' => esc_html__('Cleanup of old messages:', 'event_espresso'),
3590
-                                'html_help_text'  => esc_html__(
3591
-                                    'You can control how long a record of processed messages is kept via this option.',
3592
-                                    'event_espresso'
3593
-                                ),
3594
-                            )
3595
-                        ),
3596
-                        'update_settings'             => new EE_Submit_Input(
3597
-                            array(
3598
-                                'default'         => esc_html__('Update', 'event_espresso'),
3599
-                                'html_label_text' => '&nbsp',
3600
-                            )
3601
-                        ),
3602
-                    )
3603
-                ),
3604
-            )
3605
-        );
3606
-    }
3607
-
3608
-
3609
-    /**
3610
-     * This handles updating the global settings set on the admin page.
3611
-     *
3612
-     * @throws EE_Error
3613
-     * @throws InvalidDataTypeException
3614
-     * @throws InvalidInterfaceException
3615
-     * @throws InvalidArgumentException
3616
-     * @throws ReflectionException
3617
-     */
3618
-    protected function _update_global_settings()
3619
-    {
3620
-        /** @var EE_Network_Core_Config $network_config */
3621
-        $network_config = EE_Registry::instance()->NET_CFG->core;
3622
-        $messages_config = EE_Registry::instance()->CFG->messages;
3623
-        $form = $this->_generate_global_settings_form();
3624
-        if ($form->was_submitted()) {
3625
-            $form->receive_form_submission();
3626
-            if ($form->is_valid()) {
3627
-                $valid_data = $form->valid_data();
3628
-                foreach ($valid_data as $property => $value) {
3629
-                    $setter = 'set_' . $property;
3630
-                    if (method_exists($network_config, $setter)) {
3631
-                        $network_config->{$setter}($value);
3632
-                    } elseif (property_exists($network_config, $property)
3633
-                        && $network_config->{$property} !== $value
3634
-                    ) {
3635
-                        $network_config->{$property} = $value;
3636
-                    } elseif (property_exists($messages_config, $property)
3637
-                        && $messages_config->{$property} !== $value
3638
-                    ) {
3639
-                        $messages_config->{$property} = $value;
3640
-                    }
3641
-                }
3642
-                // only update if the form submission was valid!
3643
-                EE_Registry::instance()->NET_CFG->update_config(true, false);
3644
-                EE_Registry::instance()->CFG->update_espresso_config();
3645
-                EE_Error::overwrite_success();
3646
-                EE_Error::add_success(__('Global message settings were updated', 'event_espresso'));
3647
-            }
3648
-        }
3649
-        $this->_redirect_after_action(0, '', '', array('action' => 'settings'), true);
3650
-    }
3651
-
3652
-
3653
-    /**
3654
-     * this prepares the messenger tabs that can be dragged in and out of messenger boxes to activate/deactivate
3655
-     *
3656
-     * @param  array $tab_array This is an array of message type tab details used to generate the tabs
3657
-     * @return string html formatted tabs
3658
-     * @throws DomainException
3659
-     */
3660
-    protected function _get_mt_tabs($tab_array)
3661
-    {
3662
-        $tab_array = (array) $tab_array;
3663
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
3664
-        $tabs = '';
3665
-
3666
-        foreach ($tab_array as $tab) {
3667
-            $tabs .= EEH_Template::display_template($template, $tab, true);
3668
-        }
3669
-
3670
-        return $tabs;
3671
-    }
3672
-
3673
-
3674
-    /**
3675
-     * This prepares the content of the messenger meta box admin settings
3676
-     *
3677
-     * @param  EE_messenger $messenger The messenger we're setting up content for
3678
-     * @return string html formatted content
3679
-     * @throws DomainException
3680
-     */
3681
-    protected function _get_messenger_box_content(EE_messenger $messenger)
3682
-    {
3683
-
3684
-        $fields = $messenger->get_admin_settings_fields();
3685
-        $settings_template_args['template_form_fields'] = '';
3686
-
3687
-        // is $messenger active?
3688
-        $settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
3689
-
3690
-
3691
-        if (! empty($fields)) {
3692
-            $existing_settings = $messenger->get_existing_admin_settings();
3693
-
3694
-            foreach ($fields as $fldname => $fldprops) {
3695
-                $field_id = $messenger->name . '-' . $fldname;
3696
-                $template_form_field[ $field_id ] = array(
3697
-                    'name'       => 'messenger_settings[' . $field_id . ']',
3698
-                    'label'      => $fldprops['label'],
3699
-                    'input'      => $fldprops['field_type'],
3700
-                    'type'       => $fldprops['value_type'],
3701
-                    'required'   => $fldprops['required'],
3702
-                    'validation' => $fldprops['validation'],
3703
-                    'value'      => isset($existing_settings[ $field_id ])
3704
-                        ? $existing_settings[ $field_id ]
3705
-                        : $fldprops['default'],
3706
-                    'css_class'  => '',
3707
-                    'format'     => $fldprops['format'],
3708
-                );
3709
-            }
3710
-
3711
-
3712
-            $settings_template_args['template_form_fields'] = ! empty($template_form_field)
3713
-                ? $this->_generate_admin_form_fields($template_form_field, 'string', 'ee_m_activate_form')
3714
-                : '';
3715
-        }
3716
-
3717
-        // we also need some hidden fields
3718
-        $settings_template_args['hidden_fields'] = array(
3719
-            'messenger_settings[messenger]' => array(
3720
-                'type'  => 'hidden',
3721
-                'value' => $messenger->name,
3722
-            ),
3723
-            'type'                          => array(
3724
-                'type'  => 'hidden',
3725
-                'value' => 'messenger',
3726
-            ),
3727
-        );
3728
-
3729
-        // make sure any active message types that are existing are included in the hidden fields
3730
-        if (isset($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'])) {
3731
-            foreach ($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'] as $mt => $values) {
3732
-                $settings_template_args['hidden_fields'][ 'messenger_settings[message_types][' . $mt . ']' ] = array(
3733
-                    'type'  => 'hidden',
3734
-                    'value' => $mt,
3735
-                );
3736
-            }
3737
-        }
3738
-        $settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
3739
-            $settings_template_args['hidden_fields'],
3740
-            'array'
3741
-        );
3742
-        $active = $this->_message_resource_manager->is_messenger_active($messenger->name);
3743
-
3744
-        $settings_template_args['messenger'] = $messenger->name;
3745
-        $settings_template_args['description'] = $messenger->description;
3746
-        $settings_template_args['show_hide_edit_form'] = $active ? '' : ' hidden';
3747
-
3748
-
3749
-        $settings_template_args['show_hide_edit_form'] = $this->_message_resource_manager->is_messenger_active(
3750
-            $messenger->name
3751
-        )
3752
-            ? $settings_template_args['show_hide_edit_form']
3753
-            : ' hidden';
3754
-
3755
-        $settings_template_args['show_hide_edit_form'] = empty($settings_template_args['template_form_fields'])
3756
-            ? ' hidden'
3757
-            : $settings_template_args['show_hide_edit_form'];
3758
-
3759
-
3760
-        $settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
3761
-        $settings_template_args['nonce'] = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
3762
-        $settings_template_args['on_off_status'] = $active ? true : false;
3763
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
3764
-        $content = EEH_Template::display_template(
3765
-            $template,
3766
-            $settings_template_args,
3767
-            true
3768
-        );
3769
-
3770
-        return $content;
3771
-    }
3772
-
3773
-
3774
-    /**
3775
-     * used by ajax on the messages settings page to activate|deactivate the messenger
3776
-     *
3777
-     * @throws DomainException
3778
-     * @throws EE_Error
3779
-     * @throws InvalidDataTypeException
3780
-     * @throws InvalidInterfaceException
3781
-     * @throws InvalidArgumentException
3782
-     * @throws ReflectionException
3783
-     */
3784
-    public function activate_messenger_toggle()
3785
-    {
3786
-        $success = true;
3787
-        $this->_prep_default_response_for_messenger_or_message_type_toggle();
3788
-        // let's check that we have required data
3789
-        if (! isset($this->_req_data['messenger'])) {
3790
-            EE_Error::add_error(
3791
-                esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
3792
-                __FILE__,
3793
-                __FUNCTION__,
3794
-                __LINE__
3795
-            );
3796
-            $success = false;
3797
-        }
3798
-
3799
-        // do a nonce check here since we're not arriving via a normal route
3800
-        $nonce = isset($this->_req_data['activate_nonce'])
3801
-            ? sanitize_text_field($this->_req_data['activate_nonce'])
3802
-            : '';
3803
-        $nonce_ref = 'activate_' . $this->_req_data['messenger'] . '_toggle_nonce';
3804
-
3805
-        $this->_verify_nonce($nonce, $nonce_ref);
3806
-
3807
-
3808
-        if (! isset($this->_req_data['status'])) {
3809
-            EE_Error::add_error(
3810
-                esc_html__(
3811
-                    'Messenger status needed to know whether activation or deactivation is happening. No status is given',
3812
-                    'event_espresso'
3813
-                ),
3814
-                __FILE__,
3815
-                __FUNCTION__,
3816
-                __LINE__
3817
-            );
3818
-            $success = false;
3819
-        }
3820
-
3821
-        // do check to verify we have a valid status.
3822
-        $status = $this->_req_data['status'];
3823
-
3824
-        if ($status !== 'off' && $status !== 'on') {
3825
-            EE_Error::add_error(
3826
-                sprintf(
3827
-                    esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
3828
-                    $this->_req_data['status']
3829
-                ),
3830
-                __FILE__,
3831
-                __FUNCTION__,
3832
-                __LINE__
3833
-            );
3834
-            $success = false;
3835
-        }
3836
-
3837
-        if ($success) {
3838
-            // made it here?  Stop dawdling then!!
3839
-            $success = $status === 'off'
3840
-                ? $this->_deactivate_messenger($this->_req_data['messenger'])
3841
-                : $this->_activate_messenger($this->_req_data['messenger']);
3842
-        }
3843
-
3844
-        $this->_template_args['success'] = $success;
3845
-
3846
-        // no special instructions so let's just do the json return (which should automatically do all the special stuff).
3847
-        $this->_return_json();
3848
-    }
3849
-
3850
-
3851
-    /**
3852
-     * used by ajax from the messages settings page to activate|deactivate a message type
3853
-     *
3854
-     * @throws DomainException
3855
-     * @throws EE_Error
3856
-     * @throws ReflectionException
3857
-     * @throws InvalidDataTypeException
3858
-     * @throws InvalidInterfaceException
3859
-     * @throws InvalidArgumentException
3860
-     */
3861
-    public function activate_mt_toggle()
3862
-    {
3863
-        $success = true;
3864
-        $this->_prep_default_response_for_messenger_or_message_type_toggle();
3865
-
3866
-        // let's make sure we have the necessary data
3867
-        if (! isset($this->_req_data['message_type'])) {
3868
-            EE_Error::add_error(
3869
-                esc_html__('Message Type name needed to toggle activation. None given', 'event_espresso'),
3870
-                __FILE__,
3871
-                __FUNCTION__,
3872
-                __LINE__
3873
-            );
3874
-            $success = false;
3875
-        }
3876
-
3877
-        if (! isset($this->_req_data['messenger'])) {
3878
-            EE_Error::add_error(
3879
-                esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
3880
-                __FILE__,
3881
-                __FUNCTION__,
3882
-                __LINE__
3883
-            );
3884
-            $success = false;
3885
-        }
3886
-
3887
-        if (! isset($this->_req_data['status'])) {
3888
-            EE_Error::add_error(
3889
-                esc_html__(
3890
-                    'Messenger status needed to know whether activation or deactivation is happening. No status is given',
3891
-                    'event_espresso'
3892
-                ),
3893
-                __FILE__,
3894
-                __FUNCTION__,
3895
-                __LINE__
3896
-            );
3897
-            $success = false;
3898
-        }
3899
-
3900
-
3901
-        // do check to verify we have a valid status.
3902
-        $status = $this->_req_data['status'];
3903
-
3904
-        if ($status !== 'activate' && $status !== 'deactivate') {
3905
-            EE_Error::add_error(
3906
-                sprintf(
3907
-                    esc_html__('The given status (%s) is not valid. Must be "active" or "inactive"', 'event_espresso'),
3908
-                    $this->_req_data['status']
3909
-                ),
3910
-                __FILE__,
3911
-                __FUNCTION__,
3912
-                __LINE__
3913
-            );
3914
-            $success = false;
3915
-        }
3916
-
3917
-
3918
-        // do a nonce check here since we're not arriving via a normal route
3919
-        $nonce = isset($this->_req_data['mt_nonce']) ? sanitize_text_field($this->_req_data['mt_nonce']) : '';
3920
-        $nonce_ref = $this->_req_data['message_type'] . '_nonce';
3921
-
3922
-        $this->_verify_nonce($nonce, $nonce_ref);
3923
-
3924
-        if ($success) {
3925
-            // made it here? um, what are you waiting for then?
3926
-            $success = $status === 'deactivate'
3927
-                ? $this->_deactivate_message_type_for_messenger(
3928
-                    $this->_req_data['messenger'],
3929
-                    $this->_req_data['message_type']
3930
-                )
3931
-                : $this->_activate_message_type_for_messenger(
3932
-                    $this->_req_data['messenger'],
3933
-                    $this->_req_data['message_type']
3934
-                );
3935
-        }
3936
-
3937
-        $this->_template_args['success'] = $success;
3938
-        $this->_return_json();
3939
-    }
3940
-
3941
-
3942
-    /**
3943
-     * Takes care of processing activating a messenger and preparing the appropriate response.
3944
-     *
3945
-     * @param string $messenger_name The name of the messenger being activated
3946
-     * @return bool
3947
-     * @throws DomainException
3948
-     * @throws EE_Error
3949
-     * @throws InvalidArgumentException
3950
-     * @throws ReflectionException
3951
-     * @throws InvalidDataTypeException
3952
-     * @throws InvalidInterfaceException
3953
-     */
3954
-    protected function _activate_messenger($messenger_name)
3955
-    {
3956
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
3957
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
3958
-        $message_types_to_activate = $active_messenger instanceof EE_Messenger
3959
-            ? $active_messenger->get_default_message_types()
3960
-            : array();
3961
-
3962
-        // ensure is active
3963
-        $this->_message_resource_manager->activate_messenger($messenger_name, $message_types_to_activate);
3964
-
3965
-        // set response_data for reload
3966
-        foreach ($message_types_to_activate as $message_type_name) {
3967
-            /** @var EE_message_type $message_type */
3968
-            $message_type = $this->_message_resource_manager->get_message_type($message_type_name);
3969
-            if ($this->_message_resource_manager->is_message_type_active_for_messenger(
3970
-                $messenger_name,
3971
-                $message_type_name
3972
-            )
3973
-                && $message_type instanceof EE_message_type
3974
-            ) {
3975
-                $this->_template_args['data']['active_mts'][] = $message_type_name;
3976
-                if ($message_type->get_admin_settings_fields()) {
3977
-                    $this->_template_args['data']['mt_reload'][] = $message_type_name;
3978
-                }
3979
-            }
3980
-        }
3981
-
3982
-        // add success message for activating messenger
3983
-        return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger);
3984
-    }
3985
-
3986
-
3987
-    /**
3988
-     * Takes care of processing deactivating a messenger and preparing the appropriate response.
3989
-     *
3990
-     * @param string $messenger_name The name of the messenger being activated
3991
-     * @return bool
3992
-     * @throws DomainException
3993
-     * @throws EE_Error
3994
-     * @throws InvalidArgumentException
3995
-     * @throws ReflectionException
3996
-     * @throws InvalidDataTypeException
3997
-     * @throws InvalidInterfaceException
3998
-     */
3999
-    protected function _deactivate_messenger($messenger_name)
4000
-    {
4001
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
4002
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
4003
-        $this->_message_resource_manager->deactivate_messenger($messenger_name);
4004
-
4005
-        return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger);
4006
-    }
4007
-
4008
-
4009
-    /**
4010
-     * Takes care of processing activating a message type for a messenger and preparing the appropriate response.
4011
-     *
4012
-     * @param string $messenger_name    The name of the messenger the message type is being activated for.
4013
-     * @param string $message_type_name The name of the message type being activated for the messenger
4014
-     * @return bool
4015
-     * @throws DomainException
4016
-     * @throws EE_Error
4017
-     * @throws InvalidArgumentException
4018
-     * @throws ReflectionException
4019
-     * @throws InvalidDataTypeException
4020
-     * @throws InvalidInterfaceException
4021
-     */
4022
-    protected function _activate_message_type_for_messenger($messenger_name, $message_type_name)
4023
-    {
4024
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
4025
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
4026
-        /** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
4027
-        $message_type_to_activate = $this->_message_resource_manager->get_message_type($message_type_name);
4028
-
4029
-        // ensure is active
4030
-        $this->_message_resource_manager->activate_messenger($messenger_name, $message_type_name);
4031
-
4032
-        // set response for load
4033
-        if ($this->_message_resource_manager->is_message_type_active_for_messenger(
4034
-            $messenger_name,
4035
-            $message_type_name
4036
-        )
4037
-        ) {
4038
-            $this->_template_args['data']['active_mts'][] = $message_type_name;
4039
-            if ($message_type_to_activate->get_admin_settings_fields()) {
4040
-                $this->_template_args['data']['mt_reload'][] = $message_type_name;
4041
-            }
4042
-        }
4043
-
4044
-        return $this->_setup_response_message_for_activating_messenger_with_message_types(
4045
-            $active_messenger,
4046
-            $message_type_to_activate
4047
-        );
4048
-    }
4049
-
4050
-
4051
-    /**
4052
-     * Takes care of processing deactivating a message type for a messenger and preparing the appropriate response.
4053
-     *
4054
-     * @param string $messenger_name    The name of the messenger the message type is being deactivated for.
4055
-     * @param string $message_type_name The name of the message type being deactivated for the messenger
4056
-     * @return bool
4057
-     * @throws DomainException
4058
-     * @throws EE_Error
4059
-     * @throws InvalidArgumentException
4060
-     * @throws ReflectionException
4061
-     * @throws InvalidDataTypeException
4062
-     * @throws InvalidInterfaceException
4063
-     */
4064
-    protected function _deactivate_message_type_for_messenger($messenger_name, $message_type_name)
4065
-    {
4066
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
4067
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
4068
-        /** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
4069
-        $message_type_to_deactivate = $this->_message_resource_manager->get_message_type($message_type_name);
4070
-        $this->_message_resource_manager->deactivate_message_type_for_messenger($message_type_name, $messenger_name);
4071
-
4072
-        return $this->_setup_response_message_for_deactivating_messenger_with_message_types(
4073
-            $active_messenger,
4074
-            $message_type_to_deactivate
4075
-        );
4076
-    }
4077
-
4078
-
4079
-    /**
4080
-     * This just initializes the defaults for activating messenger and message type responses.
4081
-     */
4082
-    protected function _prep_default_response_for_messenger_or_message_type_toggle()
4083
-    {
4084
-        $this->_template_args['data']['active_mts'] = array();
4085
-        $this->_template_args['data']['mt_reload'] = array();
4086
-    }
4087
-
4088
-
4089
-    /**
4090
-     * Setup appropriate response for activating a messenger and/or message types
4091
-     *
4092
-     * @param EE_messenger         $messenger
4093
-     * @param EE_message_type|null $message_type
4094
-     * @return bool
4095
-     * @throws DomainException
4096
-     * @throws EE_Error
4097
-     * @throws InvalidArgumentException
4098
-     * @throws ReflectionException
4099
-     * @throws InvalidDataTypeException
4100
-     * @throws InvalidInterfaceException
4101
-     */
4102
-    protected function _setup_response_message_for_activating_messenger_with_message_types(
4103
-        $messenger,
4104
-        EE_Message_Type $message_type = null
4105
-    ) {
4106
-        // if $messenger isn't a valid messenger object then get out.
4107
-        if (! $messenger instanceof EE_Messenger) {
4108
-            EE_Error::add_error(
4109
-                esc_html__('The messenger being activated is not a valid messenger', 'event_espresso'),
4110
-                __FILE__,
4111
-                __FUNCTION__,
4112
-                __LINE__
4113
-            );
4114
-
4115
-            return false;
4116
-        }
4117
-        // activated
4118
-        if ($this->_template_args['data']['active_mts']) {
4119
-            EE_Error::overwrite_success();
4120
-            // activated a message type with the messenger
4121
-            if ($message_type instanceof EE_message_type) {
4122
-                EE_Error::add_success(
4123
-                    sprintf(
4124
-                        esc_html__(
4125
-                            '%s message type has been successfully activated with the %s messenger',
4126
-                            'event_espresso'
4127
-                        ),
4128
-                        ucwords($message_type->label['singular']),
4129
-                        ucwords($messenger->label['singular'])
4130
-                    )
4131
-                );
4132
-
4133
-                // if message type was invoice then let's make sure we activate the invoice payment method.
4134
-                if ($message_type->name === 'invoice') {
4135
-                    EE_Registry::instance()->load_lib('Payment_Method_Manager');
4136
-                    $pm = EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
4137
-                    if ($pm instanceof EE_Payment_Method) {
4138
-                        EE_Error::add_attention(
4139
-                            esc_html__(
4140
-                                '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.',
4141
-                                'event_espresso'
4142
-                            )
4143
-                        );
4144
-                    }
4145
-                }
4146
-                // just toggles the entire messenger
4147
-            } else {
4148
-                EE_Error::add_success(
4149
-                    sprintf(
4150
-                        esc_html__('%s messenger has been successfully activated', 'event_espresso'),
4151
-                        ucwords($messenger->label['singular'])
4152
-                    )
4153
-                );
4154
-            }
4155
-
4156
-            return true;
4157
-
4158
-            // possible error condition. This will happen when our active_mts data is empty because it is validated for actual active
4159
-            // message types after the activation process.  However its possible some messengers don't HAVE any default_message_types
4160
-            // in which case we just give a success message for the messenger being successfully activated.
4161
-        } else {
4162
-            if (! $messenger->get_default_message_types()) {
4163
-                // messenger doesn't have any default message types so still a success.
4164
-                EE_Error::add_success(
4165
-                    sprintf(
4166
-                        esc_html__('%s messenger was successfully activated.', 'event_espresso'),
4167
-                        ucwords($messenger->label['singular'])
4168
-                    )
4169
-                );
4170
-
4171
-                return true;
4172
-            } else {
4173
-                EE_Error::add_error(
4174
-                    $message_type instanceof EE_message_type
4175
-                        ? sprintf(
4176
-                            esc_html__(
4177
-                                '%s message type was not successfully activated with the %s messenger',
4178
-                                'event_espresso'
4179
-                            ),
4180
-                            ucwords($message_type->label['singular']),
4181
-                            ucwords($messenger->label['singular'])
4182
-                        )
4183
-                        : sprintf(
4184
-                            esc_html__('%s messenger was not successfully activated', 'event_espresso'),
4185
-                            ucwords($messenger->label['singular'])
4186
-                        ),
4187
-                    __FILE__,
4188
-                    __FUNCTION__,
4189
-                    __LINE__
4190
-                );
4191
-
4192
-                return false;
4193
-            }
4194
-        }
4195
-    }
4196
-
4197
-
4198
-    /**
4199
-     * This sets up the appropriate response for deactivating a messenger and/or message type.
4200
-     *
4201
-     * @param EE_messenger         $messenger
4202
-     * @param EE_message_type|null $message_type
4203
-     * @return bool
4204
-     * @throws DomainException
4205
-     * @throws EE_Error
4206
-     * @throws InvalidArgumentException
4207
-     * @throws ReflectionException
4208
-     * @throws InvalidDataTypeException
4209
-     * @throws InvalidInterfaceException
4210
-     */
4211
-    protected function _setup_response_message_for_deactivating_messenger_with_message_types(
4212
-        $messenger,
4213
-        EE_message_type $message_type = null
4214
-    ) {
4215
-        EE_Error::overwrite_success();
4216
-
4217
-        // if $messenger isn't a valid messenger object then get out.
4218
-        if (! $messenger instanceof EE_Messenger) {
4219
-            EE_Error::add_error(
4220
-                esc_html__('The messenger being deactivated is not a valid messenger', 'event_espresso'),
4221
-                __FILE__,
4222
-                __FUNCTION__,
4223
-                __LINE__
4224
-            );
4225
-
4226
-            return false;
4227
-        }
4228
-
4229
-        if ($message_type instanceof EE_message_type) {
4230
-            $message_type_name = $message_type->name;
4231
-            EE_Error::add_success(
4232
-                sprintf(
4233
-                    esc_html__(
4234
-                        '%s message type has been successfully deactivated for the %s messenger.',
4235
-                        'event_espresso'
4236
-                    ),
4237
-                    ucwords($message_type->label['singular']),
4238
-                    ucwords($messenger->label['singular'])
4239
-                )
4240
-            );
4241
-        } else {
4242
-            $message_type_name = '';
4243
-            EE_Error::add_success(
4244
-                sprintf(
4245
-                    esc_html__('%s messenger has been successfully deactivated.', 'event_espresso'),
4246
-                    ucwords($messenger->label['singular'])
4247
-                )
4248
-            );
4249
-        }
4250
-
4251
-        // if messenger was html or message type was invoice then let's make sure we deactivate invoice payment method.
4252
-        if ($messenger->name === 'html' || $message_type_name === 'invoice') {
4253
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
4254
-            $count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method('invoice');
4255
-            if ($count_updated > 0) {
4256
-                $msg = $message_type_name === 'invoice'
4257
-                    ? esc_html__(
4258
-                        '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.',
4259
-                        'event_espresso'
4260
-                    )
4261
-                    : esc_html__(
4262
-                        '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.',
4263
-                        'event_espresso'
4264
-                    );
4265
-                EE_Error::add_attention($msg);
4266
-            }
4267
-        }
4268
-
4269
-        return true;
4270
-    }
4271
-
4272
-
4273
-    /**
4274
-     * handles updating a message type form on messenger activation IF the message type has settings fields. (via ajax)
4275
-     *
4276
-     * @throws DomainException
4277
-     */
4278
-    public function update_mt_form()
4279
-    {
4280
-        if (! isset($this->_req_data['messenger']) || ! isset($this->_req_data['message_type'])) {
4281
-            EE_Error::add_error(
4282
-                esc_html__('Require message type or messenger to send an updated form', 'event_espresso'),
4283
-                __FILE__,
4284
-                __FUNCTION__,
4285
-                __LINE__
4286
-            );
4287
-            $this->_return_json();
4288
-        }
4289
-
4290
-        $message_types = $this->get_installed_message_types();
4291
-
4292
-        $message_type = $message_types[ $this->_req_data['message_type'] ];
4293
-        $messenger = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
4294
-
4295
-        $content = $this->_message_type_settings_content(
4296
-            $message_type,
4297
-            $messenger,
4298
-            true
4299
-        );
4300
-        $this->_template_args['success'] = true;
4301
-        $this->_template_args['content'] = $content;
4302
-        $this->_return_json();
4303
-    }
4304
-
4305
-
4306
-    /**
4307
-     * this handles saving the settings for a messenger or message type
4308
-     *
4309
-     */
4310
-    public function save_settings()
4311
-    {
4312
-        if (! isset($this->_req_data['type'])) {
4313
-            EE_Error::add_error(
4314
-                esc_html__(
4315
-                    'Cannot save settings because type is unknown (messenger settings or messsage type settings?)',
4316
-                    'event_espresso'
4317
-                ),
4318
-                __FILE__,
4319
-                __FUNCTION__,
4320
-                __LINE__
4321
-            );
4322
-            $this->_template_args['error'] = true;
4323
-            $this->_return_json();
4324
-        }
4325
-
4326
-
4327
-        if ($this->_req_data['type'] === 'messenger') {
4328
-            // this should be an array.
4329
-            $settings = $this->_req_data['messenger_settings'];
4330
-            $messenger = $settings['messenger'];
4331
-            // let's setup the settings data
4332
-            foreach ($settings as $key => $value) {
4333
-                switch ($key) {
4334
-                    case 'messenger':
4335
-                        unset($settings['messenger']);
4336
-                        break;
4337
-                    case 'message_types':
4338
-                        unset($settings['message_types']);
4339
-                        break;
4340
-                    default:
4341
-                        $settings[ $key ] = $value;
4342
-                        break;
4343
-                }
4344
-            }
4345
-            $this->_message_resource_manager->add_settings_for_messenger($messenger, $settings);
4346
-        } elseif ($this->_req_data['type'] === 'message_type') {
4347
-            $settings = $this->_req_data['message_type_settings'];
4348
-            $messenger = $settings['messenger'];
4349
-            $message_type = $settings['message_type'];
4350
-
4351
-            foreach ($settings as $key => $value) {
4352
-                switch ($key) {
4353
-                    case 'messenger':
4354
-                        unset($settings['messenger']);
4355
-                        break;
4356
-                    case 'message_type':
4357
-                        unset($settings['message_type']);
4358
-                        break;
4359
-                    default:
4360
-                        $settings[ $key ] = $value;
4361
-                        break;
4362
-                }
4363
-            }
4364
-
4365
-            $this->_message_resource_manager->add_settings_for_message_type($messenger, $message_type, $settings);
4366
-        }
4367
-
4368
-        // okay we should have the data all setup.  Now we just update!
4369
-        $success = $this->_message_resource_manager->update_active_messengers_option();
4370
-
4371
-        if ($success) {
4372
-            EE_Error::add_success(__('Settings updated', 'event_espresso'));
4373
-        } else {
4374
-            EE_Error::add_error(
4375
-                esc_html__(
4376
-                    'Settings did not get updated',
4377
-                    'event_espresso'
4378
-                ),
4379
-                __FILE__,
4380
-                __FUNCTION__,
4381
-                __LINE__
4382
-            );
4383
-        }
4384
-
4385
-        $this->_template_args['success'] = $success;
4386
-        $this->_return_json();
4387
-    }
4388
-
4389
-
4390
-
4391
-
4392
-    /**  EE MESSAGE PROCESSING ACTIONS **/
4393
-
4394
-
4395
-    /**
4396
-     * This immediately generates any EE_Message ID's that are selected that are EEM_Message::status_incomplete
4397
-     * However, this does not send immediately, it just queues for sending.
4398
-     *
4399
-     * @since 4.9.0
4400
-     * @throws EE_Error
4401
-     * @throws InvalidDataTypeException
4402
-     * @throws InvalidInterfaceException
4403
-     * @throws InvalidArgumentException
4404
-     * @throws ReflectionException
4405
-     */
4406
-    protected function _generate_now()
4407
-    {
4408
-        EED_Messages::generate_now($this->_get_msg_ids_from_request());
4409
-        $this->_redirect_after_action(false, '', '', array(), true);
4410
-    }
4411
-
4412
-
4413
-    /**
4414
-     * This immediately generates AND sends any EE_Message's selected that are EEM_Message::status_incomplete or that
4415
-     * are EEM_Message::status_resend or EEM_Message::status_idle
4416
-     *
4417
-     * @since 4.9.0
4418
-     * @throws EE_Error
4419
-     * @throws InvalidDataTypeException
4420
-     * @throws InvalidInterfaceException
4421
-     * @throws InvalidArgumentException
4422
-     * @throws ReflectionException
4423
-     */
4424
-    protected function _generate_and_send_now()
4425
-    {
4426
-        EED_Messages::generate_and_send_now($this->_get_msg_ids_from_request());
4427
-        $this->_redirect_after_action(false, '', '', array(), true);
4428
-    }
4429
-
4430
-
4431
-    /**
4432
-     * This queues any EEM_Message::status_sent EE_Message ids in the request for resending.
4433
-     *
4434
-     * @since 4.9.0
4435
-     * @throws EE_Error
4436
-     * @throws InvalidDataTypeException
4437
-     * @throws InvalidInterfaceException
4438
-     * @throws InvalidArgumentException
4439
-     * @throws ReflectionException
4440
-     */
4441
-    protected function _queue_for_resending()
4442
-    {
4443
-        EED_Messages::queue_for_resending($this->_get_msg_ids_from_request());
4444
-        $this->_redirect_after_action(false, '', '', array(), true);
4445
-    }
4446
-
4447
-
4448
-    /**
4449
-     *  This sends immediately any EEM_Message::status_idle or EEM_Message::status_resend messages in the queue
4450
-     *
4451
-     * @since 4.9.0
4452
-     * @throws EE_Error
4453
-     * @throws InvalidDataTypeException
4454
-     * @throws InvalidInterfaceException
4455
-     * @throws InvalidArgumentException
4456
-     * @throws ReflectionException
4457
-     */
4458
-    protected function _send_now()
4459
-    {
4460
-        EED_Messages::send_now($this->_get_msg_ids_from_request());
4461
-        $this->_redirect_after_action(false, '', '', array(), true);
4462
-    }
4463
-
4464
-
4465
-    /**
4466
-     * Deletes EE_messages for IDs in the request.
4467
-     *
4468
-     * @since 4.9.0
4469
-     * @throws EE_Error
4470
-     * @throws InvalidDataTypeException
4471
-     * @throws InvalidInterfaceException
4472
-     * @throws InvalidArgumentException
4473
-     */
4474
-    protected function _delete_ee_messages()
4475
-    {
4476
-        $msg_ids = $this->_get_msg_ids_from_request();
4477
-        $deleted_count = 0;
4478
-        foreach ($msg_ids as $msg_id) {
4479
-            if (EEM_Message::instance()->delete_by_ID($msg_id)) {
4480
-                $deleted_count++;
4481
-            }
4482
-        }
4483
-        if ($deleted_count) {
4484
-            EE_Error::add_success(
4485
-                esc_html(
4486
-                    _n(
4487
-                        'Message successfully deleted',
4488
-                        'Messages successfully deleted',
4489
-                        $deleted_count,
4490
-                        'event_espresso'
4491
-                    )
4492
-                )
4493
-            );
4494
-            $this->_redirect_after_action(
4495
-                false,
4496
-                '',
4497
-                '',
4498
-                array(),
4499
-                true
4500
-            );
4501
-        } else {
4502
-            EE_Error::add_error(
4503
-                _n('The message was not deleted.', 'The messages were not deleted', count($msg_ids), 'event_espresso'),
4504
-                __FILE__,
4505
-                __FUNCTION__,
4506
-                __LINE__
4507
-            );
4508
-            $this->_redirect_after_action(false, '', '', array(), true);
4509
-        }
4510
-    }
4511
-
4512
-
4513
-    /**
4514
-     *  This looks for 'MSG_ID' key in the request and returns an array of MSG_ID's if present.
4515
-     *
4516
-     * @since 4.9.0
4517
-     * @return array
4518
-     */
4519
-    protected function _get_msg_ids_from_request()
4520
-    {
4521
-        if (! isset($this->_req_data['MSG_ID'])) {
4522
-            return array();
4523
-        }
4524
-
4525
-        return is_array($this->_req_data['MSG_ID'])
4526
-            ? array_keys($this->_req_data['MSG_ID'])
4527
-            : array($this->_req_data['MSG_ID']);
4528
-    }
2612
+		$output = ob_get_contents();
2613
+		ob_clean();
2614
+		$this->_context_switcher = $output;
2615
+	}
2616
+
2617
+
2618
+	/**
2619
+	 * utility for sanitizing new values coming in.
2620
+	 * Note: this is only used when updating a context.
2621
+	 *
2622
+	 * @access protected
2623
+	 *
2624
+	 * @param int $index This helps us know which template field to select from the request array.
2625
+	 *
2626
+	 * @return array
2627
+	 */
2628
+	protected function _set_message_template_column_values($index)
2629
+	{
2630
+		if (is_array($this->_req_data['MTP_template_fields'][ $index ]['content'])) {
2631
+			foreach ($this->_req_data['MTP_template_fields'][ $index ]['content'] as $field => $value) {
2632
+				$this->_req_data['MTP_template_fields'][ $index ]['content'][ $field ] = $value;
2633
+			}
2634
+		}
2635
+
2636
+
2637
+		$set_column_values = array(
2638
+			'MTP_ID'             => absint($this->_req_data['MTP_template_fields'][ $index ]['MTP_ID']),
2639
+			'GRP_ID'             => absint($this->_req_data['GRP_ID']),
2640
+			'MTP_user_id'        => absint($this->_req_data['MTP_user_id']),
2641
+			'MTP_messenger'      => strtolower($this->_req_data['MTP_messenger']),
2642
+			'MTP_message_type'   => strtolower($this->_req_data['MTP_message_type']),
2643
+			'MTP_template_field' => strtolower($this->_req_data['MTP_template_fields'][ $index ]['name']),
2644
+			'MTP_context'        => strtolower($this->_req_data['MTP_context']),
2645
+			'MTP_content'        => $this->_req_data['MTP_template_fields'][ $index ]['content'],
2646
+			'MTP_is_global'      => isset($this->_req_data['MTP_is_global'])
2647
+				? absint($this->_req_data['MTP_is_global'])
2648
+				: 0,
2649
+			'MTP_is_override'    => isset($this->_req_data['MTP_is_override'])
2650
+				? absint($this->_req_data['MTP_is_override'])
2651
+				: 0,
2652
+			'MTP_deleted'        => absint($this->_req_data['MTP_deleted']),
2653
+			'MTP_is_active'      => absint($this->_req_data['MTP_is_active']),
2654
+		);
2655
+
2656
+
2657
+		return $set_column_values;
2658
+	}
2659
+
2660
+
2661
+	protected function _insert_or_update_message_template($new = false)
2662
+	{
2663
+
2664
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2665
+		$success = 0;
2666
+		$override = false;
2667
+
2668
+		// setup notices description
2669
+		$messenger_slug = ! empty($this->_req_data['MTP_messenger']) ? $this->_req_data['MTP_messenger'] : '';
2670
+
2671
+		// need the message type and messenger objects to be able to use the labels for the notices
2672
+		$messenger_object = $this->_message_resource_manager->get_messenger($messenger_slug);
2673
+		$messenger_label = $messenger_object instanceof EE_messenger
2674
+			? ucwords($messenger_object->label['singular'])
2675
+			: '';
2676
+
2677
+		$message_type_slug = ! empty($this->_req_data['MTP_message_type'])
2678
+			? $this->_req_data['MTP_message_type']
2679
+			: '';
2680
+		$message_type_object = $this->_message_resource_manager->get_message_type($message_type_slug);
2681
+
2682
+		$message_type_label = $message_type_object instanceof EE_message_type
2683
+			? ucwords($message_type_object->label['singular'])
2684
+			: '';
2685
+
2686
+		$context_slug = ! empty($this->_req_data['MTP_context'])
2687
+			? $this->_req_data['MTP_context']
2688
+			: '';
2689
+		$context = ucwords(str_replace('_', ' ', $context_slug));
2690
+
2691
+		$item_desc = $messenger_label && $message_type_label
2692
+			? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' '
2693
+			: '';
2694
+		$item_desc .= 'Message Template';
2695
+		$query_args = array();
2696
+		$edit_array = array();
2697
+		$action_desc = '';
2698
+
2699
+		// if this is "new" then we need to generate the default contexts for the selected messenger/message_type for
2700
+		// user to edit.
2701
+		if ($new) {
2702
+			$GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
2703
+			if ($edit_array = $this->_generate_new_templates($messenger_slug, $message_type_slug, $GRP_ID)) {
2704
+				if (empty($edit_array)) {
2705
+					$success = 0;
2706
+				} else {
2707
+					$success = 1;
2708
+					$edit_array = $edit_array[0];
2709
+					$query_args = array(
2710
+						'id'      => $edit_array['GRP_ID'],
2711
+						'context' => $edit_array['MTP_context'],
2712
+						'action'  => 'edit_message_template',
2713
+					);
2714
+				}
2715
+			}
2716
+			$action_desc = 'created';
2717
+		} else {
2718
+			$MTPG = EEM_Message_Template_Group::instance();
2719
+			$MTP = EEM_Message_Template::instance();
2720
+
2721
+
2722
+			// run update for each template field in displayed context
2723
+			if (! isset($this->_req_data['MTP_template_fields']) && empty($this->_req_data['MTP_template_fields'])) {
2724
+				EE_Error::add_error(
2725
+					esc_html__(
2726
+						'There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
2727
+						'event_espresso'
2728
+					),
2729
+					__FILE__,
2730
+					__FUNCTION__,
2731
+					__LINE__
2732
+				);
2733
+				$success = 0;
2734
+			} else {
2735
+				// first validate all fields!
2736
+				// this filter allows client code to add its own validation to the template fields as well.
2737
+				// returning an empty array means everything passed validation.
2738
+				// errors in validation should be represented in an array with the following shape:
2739
+				// array(
2740
+				//   'fieldname' => array(
2741
+				//          'msg' => 'error message'
2742
+				//          'value' => 'value for field producing error'
2743
+				// )
2744
+				$custom_validation = (array) apply_filters(
2745
+					'FHEE__Messages_Admin_Page___insert_or_update_message_template__validates',
2746
+					array(),
2747
+					$this->_req_data['MTP_template_fields'],
2748
+					$context_slug,
2749
+					$messenger_slug,
2750
+					$message_type_slug
2751
+				);
2752
+
2753
+				$system_validation = $MTPG->validate(
2754
+					$this->_req_data['MTP_template_fields'],
2755
+					$context_slug,
2756
+					$messenger_slug,
2757
+					$message_type_slug
2758
+				);
2759
+
2760
+				$system_validation = ! is_array($system_validation) && $system_validation ? array()
2761
+					: $system_validation;
2762
+				$validates = array_merge($custom_validation, $system_validation);
2763
+
2764
+				// if $validate returned error messages (i.e. is_array()) then we need to process them and setup an
2765
+				// appropriate response. HMM, dang this isn't correct, $validates will ALWAYS be an array.
2766
+				//  WE need to make sure there is no actual error messages in validates.
2767
+				if (is_array($validates) && ! empty($validates)) {
2768
+					// add the transient so when the form loads we know which fields to highlight
2769
+					$this->_add_transient('edit_message_template', $validates);
2770
+
2771
+					$success = 0;
2772
+
2773
+					// setup notices
2774
+					foreach ($validates as $field => $error) {
2775
+						if (isset($error['msg'])) {
2776
+							EE_Error::add_error($error['msg'], __FILE__, __FUNCTION__, __LINE__);
2777
+						}
2778
+					}
2779
+				} else {
2780
+					$set_column_values = array();
2781
+					foreach ($this->_req_data['MTP_template_fields'] as $template_field => $content) {
2782
+						$set_column_values = $this->_set_message_template_column_values($template_field);
2783
+
2784
+						$where_cols_n_values = array(
2785
+							'MTP_ID' => $this->_req_data['MTP_template_fields'][ $template_field ]['MTP_ID'],
2786
+						);
2787
+						// if they aren't allowed to use all JS, restrict them to just posty-y tags
2788
+						if (! current_user_can('unfiltered_html')) {
2789
+							if (is_array($set_column_values['MTP_content'])) {
2790
+								foreach ($set_column_values['MTP_content'] as $key => $value) {
2791
+									// remove slashes so wp_kses works properly (its wp_kses_stripslashes() function
2792
+									// only removes slashes from double-quotes, so attributes using single quotes always
2793
+									// appear invalid.) But currently the models expect slashed data, so after wp_kses
2794
+									// runs we need to re-slash the data. Sheesh. See
2795
+									// https://events.codebasehq.com/projects/event-espresso/tickets/11211#update-47321587
2796
+									$set_column_values['MTP_content'][ $key ] = addslashes(
2797
+										wp_kses(
2798
+											stripslashes($value),
2799
+											wp_kses_allowed_html('post')
2800
+										)
2801
+									);
2802
+								}
2803
+							} else {
2804
+								$set_column_values['MTP_content'] = wp_kses(
2805
+									$set_column_values['MTP_content'],
2806
+									wp_kses_allowed_html('post')
2807
+								);
2808
+							}
2809
+						}
2810
+						$message_template_fields = array(
2811
+							'GRP_ID'             => $set_column_values['GRP_ID'],
2812
+							'MTP_template_field' => $set_column_values['MTP_template_field'],
2813
+							'MTP_context'        => $set_column_values['MTP_context'],
2814
+							'MTP_content'        => $set_column_values['MTP_content'],
2815
+						);
2816
+						if ($updated = $MTP->update($message_template_fields, array($where_cols_n_values))) {
2817
+							if ($updated === false) {
2818
+								EE_Error::add_error(
2819
+									sprintf(
2820
+										esc_html__('%s field was NOT updated for some reason', 'event_espresso'),
2821
+										$template_field
2822
+									),
2823
+									__FILE__,
2824
+									__FUNCTION__,
2825
+									__LINE__
2826
+								);
2827
+							} else {
2828
+								$success = 1;
2829
+							}
2830
+						} else {
2831
+							// only do this logic if we don't have a MTP_ID for this field
2832
+							if (empty($this->_req_data['MTP_template_fields'][ $template_field ]['MTP_ID'])) {
2833
+								// this has already been through the template field validator and sanitized, so it will be
2834
+								// safe to insert this field.  Why insert?  This typically happens when we introduce a new
2835
+								// message template field in a messenger/message type and existing users don't have the
2836
+								// default setup for it.
2837
+								// @link https://events.codebasehq.com/projects/event-espresso/tickets/9465
2838
+								$updated = $MTP->insert($message_template_fields);
2839
+								if (! $updated || is_wp_error($updated)) {
2840
+									EE_Error::add_error(
2841
+										sprintf(
2842
+											esc_html__('%s field could not be updated.', 'event_espresso'),
2843
+											$template_field
2844
+										),
2845
+										__FILE__,
2846
+										__FUNCTION__,
2847
+										__LINE__
2848
+									);
2849
+									$success = 0;
2850
+								} else {
2851
+									$success = 1;
2852
+								}
2853
+							}
2854
+						}
2855
+						$action_desc = 'updated';
2856
+					}
2857
+
2858
+					// we can use the last set_column_values for the MTPG update (because its the same for all of these specific MTPs)
2859
+					$mtpg_fields = array(
2860
+						'MTP_user_id'      => $set_column_values['MTP_user_id'],
2861
+						'MTP_messenger'    => $set_column_values['MTP_messenger'],
2862
+						'MTP_message_type' => $set_column_values['MTP_message_type'],
2863
+						'MTP_is_global'    => $set_column_values['MTP_is_global'],
2864
+						'MTP_is_override'  => $set_column_values['MTP_is_override'],
2865
+						'MTP_deleted'      => $set_column_values['MTP_deleted'],
2866
+						'MTP_is_active'    => $set_column_values['MTP_is_active'],
2867
+						'MTP_name'         => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_name'])
2868
+							? $this->_req_data['ee_msg_non_global_fields']['MTP_name']
2869
+							: '',
2870
+						'MTP_description'  => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_description'])
2871
+							? $this->_req_data['ee_msg_non_global_fields']['MTP_description']
2872
+							: '',
2873
+					);
2874
+
2875
+					$mtpg_where = array('GRP_ID' => $set_column_values['GRP_ID']);
2876
+					$updated = $MTPG->update($mtpg_fields, array($mtpg_where));
2877
+
2878
+					if ($updated === false) {
2879
+						EE_Error::add_error(
2880
+							sprintf(
2881
+								esc_html__(
2882
+									'The Message Template Group (%d) was NOT updated for some reason',
2883
+									'event_espresso'
2884
+								),
2885
+								$set_column_values['GRP_ID']
2886
+							),
2887
+							__FILE__,
2888
+							__FUNCTION__,
2889
+							__LINE__
2890
+						);
2891
+					} else {
2892
+						// k now we need to ensure the template_pack and template_variation fields are set.
2893
+						$template_pack = ! empty($this->_req_data['MTP_template_pack'])
2894
+							? $this->_req_data['MTP_template_pack']
2895
+							: 'default';
2896
+
2897
+						$template_variation = ! empty($this->_req_data['MTP_template_variation'])
2898
+							? $this->_req_data['MTP_template_variation']
2899
+							: 'default';
2900
+
2901
+						$mtpg_obj = $MTPG->get_one_by_ID($set_column_values['GRP_ID']);
2902
+						if ($mtpg_obj instanceof EE_Message_Template_Group) {
2903
+							$mtpg_obj->set_template_pack_name($template_pack);
2904
+							$mtpg_obj->set_template_pack_variation($template_variation);
2905
+						}
2906
+						$success = 1;
2907
+					}
2908
+				}
2909
+			}
2910
+		}
2911
+
2912
+		// we return things differently if doing ajax
2913
+		if (defined('DOING_AJAX') && DOING_AJAX) {
2914
+			$this->_template_args['success'] = $success;
2915
+			$this->_template_args['error'] = ! $success ? true : false;
2916
+			$this->_template_args['content'] = '';
2917
+			$this->_template_args['data'] = array(
2918
+				'grpID'        => $edit_array['GRP_ID'],
2919
+				'templateName' => $edit_array['template_name'],
2920
+			);
2921
+			if ($success) {
2922
+				EE_Error::overwrite_success();
2923
+				EE_Error::add_success(
2924
+					esc_html__(
2925
+						'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.',
2926
+						'event_espresso'
2927
+					)
2928
+				);
2929
+			}
2930
+
2931
+			$this->_return_json();
2932
+		}
2933
+
2934
+
2935
+		// was a test send triggered?
2936
+		if (isset($this->_req_data['test_button'])) {
2937
+			EE_Error::overwrite_success();
2938
+			$this->_do_test_send($context_slug, $messenger_slug, $message_type_slug);
2939
+			$override = true;
2940
+		}
2941
+
2942
+		if (empty($query_args)) {
2943
+			$query_args = array(
2944
+				'id'      => $this->_req_data['GRP_ID'],
2945
+				'context' => $context_slug,
2946
+				'action'  => 'edit_message_template',
2947
+			);
2948
+		}
2949
+
2950
+		$this->_redirect_after_action($success, $item_desc, $action_desc, $query_args, $override);
2951
+	}
2952
+
2953
+
2954
+	/**
2955
+	 * processes a test send request to do an actual messenger delivery test for the given message template being tested
2956
+	 *
2957
+	 * @param  string $context      what context being tested
2958
+	 * @param  string $messenger    messenger being tested
2959
+	 * @param  string $message_type message type being tested
2960
+	 * @throws EE_Error
2961
+	 * @throws InvalidArgumentException
2962
+	 * @throws InvalidDataTypeException
2963
+	 * @throws InvalidInterfaceException
2964
+	 */
2965
+	protected function _do_test_send($context, $messenger, $message_type)
2966
+	{
2967
+		// set things up for preview
2968
+		$this->_req_data['messenger'] = $messenger;
2969
+		$this->_req_data['message_type'] = $message_type;
2970
+		$this->_req_data['context'] = $context;
2971
+		$this->_req_data['GRP_ID'] = isset($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : '';
2972
+		$active_messenger = $this->_message_resource_manager->get_active_messenger($messenger);
2973
+
2974
+		// let's save any existing fields that might be required by the messenger
2975
+		if (isset($this->_req_data['test_settings_fld'])
2976
+			&& $active_messenger instanceof EE_messenger
2977
+			&& apply_filters(
2978
+				'FHEE__Messages_Admin_Page__do_test_send__set_existing_test_settings',
2979
+				true,
2980
+				$this->_req_data['test_settings_fld'],
2981
+				$active_messenger
2982
+			)
2983
+		) {
2984
+			$active_messenger->set_existing_test_settings($this->_req_data['test_settings_fld']);
2985
+		}
2986
+
2987
+		/**
2988
+		 * Use filter to add additional controls on whether message can send or not
2989
+		 */
2990
+		if (apply_filters(
2991
+			'FHEE__Messages_Admin_Page__do_test_send__can_send',
2992
+			true,
2993
+			$context,
2994
+			$this->_req_data,
2995
+			$messenger,
2996
+			$message_type
2997
+		)) {
2998
+			$success = $this->_preview_message(true);
2999
+			if ($success) {
3000
+				EE_Error::add_success(__('Test message sent', 'event_espresso'));
3001
+			} else {
3002
+				EE_Error::add_error(
3003
+					esc_html__('The test message was not sent', 'event_espresso'),
3004
+					__FILE__,
3005
+					__FUNCTION__,
3006
+					__LINE__
3007
+				);
3008
+			}
3009
+		}
3010
+	}
3011
+
3012
+
3013
+	/**
3014
+	 * _generate_new_templates
3015
+	 * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will
3016
+	 * automatically create the defaults for the event.  The user would then be redirected to edit the default context
3017
+	 * for the event.
3018
+	 *
3019
+	 *
3020
+	 * @param  string $messenger     the messenger we are generating templates for
3021
+	 * @param array   $message_types array of message types that the templates are generated for.
3022
+	 * @param int     $GRP_ID        If this is a custom template being generated then a GRP_ID needs to be included to
3023
+	 *                               indicate the message_template_group being used as the base.
3024
+	 *
3025
+	 * @param bool    $global
3026
+	 *
3027
+	 * @return array|bool array of data required for the redirect to the correct edit page or bool if
3028
+	 *                               encountering problems.
3029
+	 * @throws EE_Error
3030
+	 */
3031
+	protected function _generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
3032
+	{
3033
+
3034
+		// if no $message_types are given then that's okay... this may be a messenger that just adds shortcodes, so we
3035
+		// just don't generate any templates.
3036
+		if (empty($message_types)) {
3037
+			return true;
3038
+		}
3039
+
3040
+		return EEH_MSG_Template::generate_new_templates($messenger, $message_types, $GRP_ID, $global);
3041
+	}
3042
+
3043
+
3044
+	/**
3045
+	 * [_trash_or_restore_message_template]
3046
+	 *
3047
+	 * @param  boolean $trash whether to move an item to trash/restore (TRUE) or restore it (FALSE)
3048
+	 * @param boolean  $all   whether this is going to trash/restore all contexts within a template group (TRUE) OR just
3049
+	 *                        an individual context (FALSE).
3050
+	 * @return void
3051
+	 * @throws EE_Error
3052
+	 * @throws InvalidArgumentException
3053
+	 * @throws InvalidDataTypeException
3054
+	 * @throws InvalidInterfaceException
3055
+	 */
3056
+	protected function _trash_or_restore_message_template($trash = true, $all = false)
3057
+	{
3058
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
3059
+		$MTP = EEM_Message_Template_Group::instance();
3060
+
3061
+		$success = 1;
3062
+
3063
+		// incoming GRP_IDs
3064
+		if ($all) {
3065
+			// Checkboxes
3066
+			if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
3067
+				// if array has more than one element then success message should be plural.
3068
+				// todo: what about nonce?
3069
+				$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
3070
+
3071
+				// cycle through checkboxes
3072
+				while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
3073
+					$trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
3074
+					if (! $trashed_or_restored) {
3075
+						$success = 0;
3076
+					}
3077
+				}
3078
+			} else {
3079
+				// grab single GRP_ID and handle
3080
+				$GRP_ID = isset($this->_req_data['id']) ? absint($this->_req_data['id']) : 0;
3081
+				if (! empty($GRP_ID)) {
3082
+					$trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
3083
+					if (! $trashed_or_restored) {
3084
+						$success = 0;
3085
+					}
3086
+				} else {
3087
+					$success = 0;
3088
+				}
3089
+			}
3090
+		}
3091
+
3092
+		$action_desc = $trash
3093
+			? esc_html__('moved to the trash', 'event_espresso')
3094
+			: esc_html__('restored', 'event_espresso');
3095
+
3096
+		$action_desc = ! empty($this->_req_data['template_switch']) ? esc_html__('switched', 'event_espresso') : $action_desc;
3097
+
3098
+		$item_desc = $all ? _n(
3099
+			'Message Template Group',
3100
+			'Message Template Groups',
3101
+			$success,
3102
+			'event_espresso'
3103
+		) : _n('Message Template Context', 'Message Template Contexts', $success, 'event_espresso');
3104
+
3105
+		$item_desc = ! empty($this->_req_data['template_switch']) ? _n(
3106
+			'template',
3107
+			'templates',
3108
+			$success,
3109
+			'event_espresso'
3110
+		) : $item_desc;
3111
+
3112
+		$this->_redirect_after_action($success, $item_desc, $action_desc, array());
3113
+	}
3114
+
3115
+
3116
+	/**
3117
+	 * [_delete_message_template]
3118
+	 * NOTE: this handles not only the deletion of the groups but also all the templates belonging to that group.
3119
+	 *
3120
+	 * @return void
3121
+	 * @throws EE_Error
3122
+	 * @throws InvalidArgumentException
3123
+	 * @throws InvalidDataTypeException
3124
+	 * @throws InvalidInterfaceException
3125
+	 */
3126
+	protected function _delete_message_template()
3127
+	{
3128
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
3129
+
3130
+		// checkboxes
3131
+		if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
3132
+			// if array has more than one element then success message should be plural
3133
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
3134
+
3135
+			// cycle through bulk action checkboxes
3136
+			while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
3137
+				$success = $this->_delete_mtp_permanently($GRP_ID);
3138
+			}
3139
+		} else {
3140
+			// grab single grp_id and delete
3141
+			$GRP_ID = absint($this->_req_data['id']);
3142
+			$success = $this->_delete_mtp_permanently($GRP_ID);
3143
+		}
3144
+
3145
+		$this->_redirect_after_action($success, 'Message Templates', 'deleted', array());
3146
+	}
3147
+
3148
+
3149
+	/**
3150
+	 * helper for permanently deleting a mtP group and all related message_templates
3151
+	 *
3152
+	 * @param  int  $GRP_ID        The group being deleted
3153
+	 * @param  bool $include_group whether to delete the Message Template Group as well.
3154
+	 * @return bool boolean to indicate the success of the deletes or not.
3155
+	 * @throws EE_Error
3156
+	 * @throws InvalidArgumentException
3157
+	 * @throws InvalidDataTypeException
3158
+	 * @throws InvalidInterfaceException
3159
+	 */
3160
+	private function _delete_mtp_permanently($GRP_ID, $include_group = true)
3161
+	{
3162
+		$success = 1;
3163
+		$MTPG = EEM_Message_Template_Group::instance();
3164
+		// first let's GET this group
3165
+		$MTG = $MTPG->get_one_by_ID($GRP_ID);
3166
+		// then delete permanently all the related Message Templates
3167
+		$deleted = $MTG->delete_related_permanently('Message_Template');
3168
+
3169
+		if ($deleted === 0) {
3170
+			$success = 0;
3171
+		}
3172
+
3173
+		// now delete permanently this particular group
3174
+
3175
+		if ($include_group && ! $MTG->delete_permanently()) {
3176
+			$success = 0;
3177
+		}
3178
+
3179
+		return $success;
3180
+	}
3181
+
3182
+
3183
+	/**
3184
+	 *    _learn_more_about_message_templates_link
3185
+	 *
3186
+	 * @access protected
3187
+	 * @return string
3188
+	 */
3189
+	protected function _learn_more_about_message_templates_link()
3190
+	{
3191
+		return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >'
3192
+			   . esc_html__('learn more about how message templates works', 'event_espresso')
3193
+			   . '</a>';
3194
+	}
3195
+
3196
+
3197
+	/**
3198
+	 * Used for setting up messenger/message type activation.  This loads up the initial view.  The rest is handled by
3199
+	 * ajax and other routes.
3200
+	 *
3201
+	 * @return void
3202
+	 * @throws DomainException
3203
+	 */
3204
+	protected function _settings()
3205
+	{
3206
+
3207
+
3208
+		$this->_set_m_mt_settings();
3209
+
3210
+		$selected_messenger = isset($this->_req_data['selected_messenger'])
3211
+			? $this->_req_data['selected_messenger']
3212
+			: 'email';
3213
+
3214
+		// let's setup the messenger tabs
3215
+		$this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
3216
+			$this->_m_mt_settings['messenger_tabs'],
3217
+			'messenger_links',
3218
+			'|',
3219
+			$selected_messenger
3220
+		);
3221
+		$this->_template_args['before_admin_page_content'] = '<div class="ui-widget ui-helper-clearfix">';
3222
+		$this->_template_args['after_admin_page_content'] = '</div><!-- end .ui-widget -->';
3223
+
3224
+		$this->display_admin_page_with_sidebar();
3225
+	}
3226
+
3227
+
3228
+	/**
3229
+	 * This sets the $_m_mt_settings property for when needed (used on the Messages settings page)
3230
+	 *
3231
+	 * @access protected
3232
+	 * @return void
3233
+	 * @throws DomainException
3234
+	 */
3235
+	protected function _set_m_mt_settings()
3236
+	{
3237
+		// first if this is already set then lets get out no need to regenerate data.
3238
+		if (! empty($this->_m_mt_settings)) {
3239
+			return;
3240
+		}
3241
+
3242
+		// get all installed messengers and message_types
3243
+		/** @type EE_messenger[] $messengers */
3244
+		$messengers = $this->_message_resource_manager->installed_messengers();
3245
+		/** @type EE_message_type[] $message_types */
3246
+		$message_types = $this->_message_resource_manager->installed_message_types();
3247
+
3248
+
3249
+		// assemble the array for the _tab_text_links helper
3250
+
3251
+		foreach ($messengers as $messenger) {
3252
+			$this->_m_mt_settings['messenger_tabs'][ $messenger->name ] = array(
3253
+				'label' => ucwords($messenger->label['singular']),
3254
+				'class' => $this->_message_resource_manager->is_messenger_active($messenger->name)
3255
+					? 'messenger-active'
3256
+					: '',
3257
+				'href'  => $messenger->name,
3258
+				'title' => esc_html__('Modify this Messenger', 'event_espresso'),
3259
+				'slug'  => $messenger->name,
3260
+				'obj'   => $messenger,
3261
+			);
3262
+
3263
+
3264
+			$message_types_for_messenger = $messenger->get_valid_message_types();
3265
+
3266
+			foreach ($message_types as $message_type) {
3267
+				// first we need to verify that this message type is valid with this messenger. Cause if it isn't then
3268
+				// it shouldn't show in either the inactive OR active metabox.
3269
+				if (! in_array($message_type->name, $message_types_for_messenger, true)) {
3270
+					continue;
3271
+				}
3272
+
3273
+				$a_or_i = $this->_message_resource_manager->is_message_type_active_for_messenger(
3274
+					$messenger->name,
3275
+					$message_type->name
3276
+				)
3277
+					? 'active'
3278
+					: 'inactive';
3279
+
3280
+				$this->_m_mt_settings['message_type_tabs'][ $messenger->name ][ $a_or_i ][ $message_type->name ] = array(
3281
+					'label'    => ucwords($message_type->label['singular']),
3282
+					'class'    => 'message-type-' . $a_or_i,
3283
+					'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
3284
+					'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
3285
+					'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
3286
+					'title'    => $a_or_i === 'active'
3287
+						? esc_html__('Drag this message type to the Inactive window to deactivate', 'event_espresso')
3288
+						: esc_html__('Drag this message type to the messenger to activate', 'event_espresso'),
3289
+					'content'  => $a_or_i === 'active'
3290
+						? $this->_message_type_settings_content($message_type, $messenger, true)
3291
+						: $this->_message_type_settings_content($message_type, $messenger),
3292
+					'slug'     => $message_type->name,
3293
+					'active'   => $a_or_i === 'active',
3294
+					'obj'      => $message_type,
3295
+				);
3296
+			}
3297
+		}
3298
+	}
3299
+
3300
+
3301
+	/**
3302
+	 * This just prepares the content for the message type settings
3303
+	 *
3304
+	 * @param  EE_message_type $message_type The message type object
3305
+	 * @param  EE_messenger    $messenger    The messenger object
3306
+	 * @param  boolean         $active       Whether the message type is active or not
3307
+	 * @return string html output for the content
3308
+	 * @throws DomainException
3309
+	 */
3310
+	protected function _message_type_settings_content($message_type, $messenger, $active = false)
3311
+	{
3312
+		// get message type fields
3313
+		$fields = $message_type->get_admin_settings_fields();
3314
+		$settings_template_args['template_form_fields'] = '';
3315
+
3316
+		if (! empty($fields) && $active) {
3317
+			$existing_settings = $message_type->get_existing_admin_settings($messenger->name);
3318
+			foreach ($fields as $fldname => $fldprops) {
3319
+				$field_id = $messenger->name . '-' . $message_type->name . '-' . $fldname;
3320
+				$template_form_field[ $field_id ] = array(
3321
+					'name'       => 'message_type_settings[' . $fldname . ']',
3322
+					'label'      => $fldprops['label'],
3323
+					'input'      => $fldprops['field_type'],
3324
+					'type'       => $fldprops['value_type'],
3325
+					'required'   => $fldprops['required'],
3326
+					'validation' => $fldprops['validation'],
3327
+					'value'      => isset($existing_settings[ $fldname ])
3328
+						? $existing_settings[ $fldname ]
3329
+						: $fldprops['default'],
3330
+					'options'    => isset($fldprops['options'])
3331
+						? $fldprops['options']
3332
+						: array(),
3333
+					'default'    => isset($existing_settings[ $fldname ])
3334
+						? $existing_settings[ $fldname ]
3335
+						: $fldprops['default'],
3336
+					'css_class'  => 'no-drag',
3337
+					'format'     => $fldprops['format'],
3338
+				);
3339
+			}
3340
+
3341
+
3342
+			$settings_template_args['template_form_fields'] = ! empty($template_form_field)
3343
+				? $this->_generate_admin_form_fields(
3344
+					$template_form_field,
3345
+					'string',
3346
+					'ee_mt_activate_form'
3347
+				)
3348
+				: '';
3349
+		}
3350
+
3351
+		$settings_template_args['description'] = $message_type->description;
3352
+		// we also need some hidden fields
3353
+		$settings_template_args['hidden_fields'] = array(
3354
+			'message_type_settings[messenger]'    => array(
3355
+				'type'  => 'hidden',
3356
+				'value' => $messenger->name,
3357
+			),
3358
+			'message_type_settings[message_type]' => array(
3359
+				'type'  => 'hidden',
3360
+				'value' => $message_type->name,
3361
+			),
3362
+			'type'                                => array(
3363
+				'type'  => 'hidden',
3364
+				'value' => 'message_type',
3365
+			),
3366
+		);
3367
+
3368
+		$settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
3369
+			$settings_template_args['hidden_fields'],
3370
+			'array'
3371
+		);
3372
+		$settings_template_args['show_form'] = empty($settings_template_args['template_form_fields'])
3373
+			? ' hidden'
3374
+			: '';
3375
+
3376
+
3377
+		$template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
3378
+		$content = EEH_Template::display_template($template, $settings_template_args, true);
3379
+
3380
+		return $content;
3381
+	}
3382
+
3383
+
3384
+	/**
3385
+	 * Generate all the metaboxes for the message types and register them for the messages settings page.
3386
+	 *
3387
+	 * @access protected
3388
+	 * @return void
3389
+	 * @throws DomainException
3390
+	 */
3391
+	protected function _messages_settings_metaboxes()
3392
+	{
3393
+		$this->_set_m_mt_settings();
3394
+		$m_boxes = $mt_boxes = array();
3395
+		$m_template_args = $mt_template_args = array();
3396
+
3397
+		$selected_messenger = isset($this->_req_data['selected_messenger'])
3398
+			? $this->_req_data['selected_messenger']
3399
+			: 'email';
3400
+
3401
+		if (isset($this->_m_mt_settings['messenger_tabs'])) {
3402
+			foreach ($this->_m_mt_settings['messenger_tabs'] as $messenger => $tab_array) {
3403
+				$hide_on_message = $this->_message_resource_manager->is_messenger_active($messenger) ? '' : 'hidden';
3404
+				$hide_off_message = $this->_message_resource_manager->is_messenger_active($messenger) ? 'hidden' : '';
3405
+				// messenger meta boxes
3406
+				$active = $selected_messenger === $messenger;
3407
+				$active_mt_tabs = isset(
3408
+					$this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
3409
+				)
3410
+					? $this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
3411
+					: '';
3412
+				$m_boxes[ $messenger . '_a_box' ] = sprintf(
3413
+					esc_html__('%s Settings', 'event_espresso'),
3414
+					$tab_array['label']
3415
+				);
3416
+				$m_template_args[ $messenger . '_a_box' ] = array(
3417
+					'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
3418
+					'inactive_message_types' => isset(
3419
+						$this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
3420
+					)
3421
+						? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
3422
+						: '',
3423
+					'content'                => $this->_get_messenger_box_content($tab_array['obj']),
3424
+					'hidden'                 => $active ? '' : ' hidden',
3425
+					'hide_on_message'        => $hide_on_message,
3426
+					'messenger'              => $messenger,
3427
+					'active'                 => $active,
3428
+				);
3429
+				// message type meta boxes
3430
+				// (which is really just the inactive container for each messenger
3431
+				// showing inactive message types for that messenger)
3432
+				$mt_boxes[ $messenger . '_i_box' ] = esc_html__('Inactive Message Types', 'event_espresso');
3433
+				$mt_template_args[ $messenger . '_i_box' ] = array(
3434
+					'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
3435
+					'inactive_message_types' => isset(
3436
+						$this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
3437
+					)
3438
+						? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
3439
+						: '',
3440
+					'hidden'                 => $active ? '' : ' hidden',
3441
+					'hide_on_message'        => $hide_on_message,
3442
+					'hide_off_message'       => $hide_off_message,
3443
+					'messenger'              => $messenger,
3444
+					'active'                 => $active,
3445
+				);
3446
+			}
3447
+		}
3448
+
3449
+
3450
+		// register messenger metaboxes
3451
+		$m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
3452
+		foreach ($m_boxes as $box => $label) {
3453
+			$callback_args = array('template_path' => $m_template_path, 'template_args' => $m_template_args[ $box ]);
3454
+			$msgr = str_replace('_a_box', '', $box);
3455
+			add_meta_box(
3456
+				'espresso_' . $msgr . '_settings',
3457
+				$label,
3458
+				function ($post, $metabox) {
3459
+					echo EEH_Template::display_template(
3460
+						$metabox["args"]["template_path"],
3461
+						$metabox["args"]["template_args"],
3462
+						true
3463
+					);
3464
+				},
3465
+				$this->_current_screen->id,
3466
+				'normal',
3467
+				'high',
3468
+				$callback_args
3469
+			);
3470
+		}
3471
+
3472
+		// register message type metaboxes
3473
+		$mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
3474
+		foreach ($mt_boxes as $box => $label) {
3475
+			$callback_args = array(
3476
+				'template_path' => $mt_template_path,
3477
+				'template_args' => $mt_template_args[ $box ],
3478
+			);
3479
+			$mt = str_replace('_i_box', '', $box);
3480
+			add_meta_box(
3481
+				'espresso_' . $mt . '_inactive_mts',
3482
+				$label,
3483
+				function ($post, $metabox) {
3484
+					echo EEH_Template::display_template(
3485
+						$metabox["args"]["template_path"],
3486
+						$metabox["args"]["template_args"],
3487
+						true
3488
+					);
3489
+				},
3490
+				$this->_current_screen->id,
3491
+				'side',
3492
+				'high',
3493
+				$callback_args
3494
+			);
3495
+		}
3496
+
3497
+		// register metabox for global messages settings but only when on the main site.  On single site installs this
3498
+		// will always result in the metabox showing, on multisite installs the metabox will only show on the main site.
3499
+		if (is_main_site()) {
3500
+			add_meta_box(
3501
+				'espresso_global_message_settings',
3502
+				esc_html__('Global Message Settings', 'event_espresso'),
3503
+				array($this, 'global_messages_settings_metabox_content'),
3504
+				$this->_current_screen->id,
3505
+				'normal',
3506
+				'low',
3507
+				array()
3508
+			);
3509
+		}
3510
+	}
3511
+
3512
+
3513
+	/**
3514
+	 *  This generates the content for the global messages settings metabox.
3515
+	 *
3516
+	 * @return string
3517
+	 * @throws EE_Error
3518
+	 * @throws InvalidArgumentException
3519
+	 * @throws ReflectionException
3520
+	 * @throws InvalidDataTypeException
3521
+	 * @throws InvalidInterfaceException
3522
+	 */
3523
+	public function global_messages_settings_metabox_content()
3524
+	{
3525
+		$form = $this->_generate_global_settings_form();
3526
+		echo $form->form_open(
3527
+			$this->add_query_args_and_nonce(array('action' => 'update_global_settings'), EE_MSG_ADMIN_URL),
3528
+			'POST'
3529
+		)
3530
+			 . $form->get_html()
3531
+			 . $form->form_close();
3532
+	}
3533
+
3534
+
3535
+	/**
3536
+	 * This generates and returns the form object for the global messages settings.
3537
+	 *
3538
+	 * @return EE_Form_Section_Proper
3539
+	 * @throws EE_Error
3540
+	 * @throws InvalidArgumentException
3541
+	 * @throws ReflectionException
3542
+	 * @throws InvalidDataTypeException
3543
+	 * @throws InvalidInterfaceException
3544
+	 */
3545
+	protected function _generate_global_settings_form()
3546
+	{
3547
+		EE_Registry::instance()->load_helper('HTML');
3548
+		/** @var EE_Network_Core_Config $network_config */
3549
+		$network_config = EE_Registry::instance()->NET_CFG->core;
3550
+
3551
+		return new EE_Form_Section_Proper(
3552
+			array(
3553
+				'name'            => 'global_messages_settings',
3554
+				'html_id'         => 'global_messages_settings',
3555
+				'html_class'      => 'form-table',
3556
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
3557
+				'subsections'     => apply_filters(
3558
+					'FHEE__Messages_Admin_Page__global_messages_settings_metabox_content__form_subsections',
3559
+					array(
3560
+						'do_messages_on_same_request' => new EE_Select_Input(
3561
+							array(
3562
+								true  => esc_html__("On the same request", "event_espresso"),
3563
+								false => esc_html__("On a separate request", "event_espresso"),
3564
+							),
3565
+							array(
3566
+								'default'         => $network_config->do_messages_on_same_request,
3567
+								'html_label_text' => esc_html__(
3568
+									'Generate and send all messages:',
3569
+									'event_espresso'
3570
+								),
3571
+								'html_help_text'  => esc_html__(
3572
+									'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.',
3573
+									'event_espresso'
3574
+								),
3575
+							)
3576
+						),
3577
+						'delete_threshold'            => new EE_Select_Input(
3578
+							array(
3579
+								0  => esc_html__('Forever', 'event_espresso'),
3580
+								3  => esc_html__('3 Months', 'event_espresso'),
3581
+								6  => esc_html__('6 Months', 'event_espresso'),
3582
+								9  => esc_html__('9 Months', 'event_espresso'),
3583
+								12 => esc_html__('12 Months', 'event_espresso'),
3584
+								24 => esc_html__('24 Months', 'event_espresso'),
3585
+								36 => esc_html__('36 Months', 'event_espresso'),
3586
+							),
3587
+							array(
3588
+								'default'         => EE_Registry::instance()->CFG->messages->delete_threshold,
3589
+								'html_label_text' => esc_html__('Cleanup of old messages:', 'event_espresso'),
3590
+								'html_help_text'  => esc_html__(
3591
+									'You can control how long a record of processed messages is kept via this option.',
3592
+									'event_espresso'
3593
+								),
3594
+							)
3595
+						),
3596
+						'update_settings'             => new EE_Submit_Input(
3597
+							array(
3598
+								'default'         => esc_html__('Update', 'event_espresso'),
3599
+								'html_label_text' => '&nbsp',
3600
+							)
3601
+						),
3602
+					)
3603
+				),
3604
+			)
3605
+		);
3606
+	}
3607
+
3608
+
3609
+	/**
3610
+	 * This handles updating the global settings set on the admin page.
3611
+	 *
3612
+	 * @throws EE_Error
3613
+	 * @throws InvalidDataTypeException
3614
+	 * @throws InvalidInterfaceException
3615
+	 * @throws InvalidArgumentException
3616
+	 * @throws ReflectionException
3617
+	 */
3618
+	protected function _update_global_settings()
3619
+	{
3620
+		/** @var EE_Network_Core_Config $network_config */
3621
+		$network_config = EE_Registry::instance()->NET_CFG->core;
3622
+		$messages_config = EE_Registry::instance()->CFG->messages;
3623
+		$form = $this->_generate_global_settings_form();
3624
+		if ($form->was_submitted()) {
3625
+			$form->receive_form_submission();
3626
+			if ($form->is_valid()) {
3627
+				$valid_data = $form->valid_data();
3628
+				foreach ($valid_data as $property => $value) {
3629
+					$setter = 'set_' . $property;
3630
+					if (method_exists($network_config, $setter)) {
3631
+						$network_config->{$setter}($value);
3632
+					} elseif (property_exists($network_config, $property)
3633
+						&& $network_config->{$property} !== $value
3634
+					) {
3635
+						$network_config->{$property} = $value;
3636
+					} elseif (property_exists($messages_config, $property)
3637
+						&& $messages_config->{$property} !== $value
3638
+					) {
3639
+						$messages_config->{$property} = $value;
3640
+					}
3641
+				}
3642
+				// only update if the form submission was valid!
3643
+				EE_Registry::instance()->NET_CFG->update_config(true, false);
3644
+				EE_Registry::instance()->CFG->update_espresso_config();
3645
+				EE_Error::overwrite_success();
3646
+				EE_Error::add_success(__('Global message settings were updated', 'event_espresso'));
3647
+			}
3648
+		}
3649
+		$this->_redirect_after_action(0, '', '', array('action' => 'settings'), true);
3650
+	}
3651
+
3652
+
3653
+	/**
3654
+	 * this prepares the messenger tabs that can be dragged in and out of messenger boxes to activate/deactivate
3655
+	 *
3656
+	 * @param  array $tab_array This is an array of message type tab details used to generate the tabs
3657
+	 * @return string html formatted tabs
3658
+	 * @throws DomainException
3659
+	 */
3660
+	protected function _get_mt_tabs($tab_array)
3661
+	{
3662
+		$tab_array = (array) $tab_array;
3663
+		$template = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
3664
+		$tabs = '';
3665
+
3666
+		foreach ($tab_array as $tab) {
3667
+			$tabs .= EEH_Template::display_template($template, $tab, true);
3668
+		}
3669
+
3670
+		return $tabs;
3671
+	}
3672
+
3673
+
3674
+	/**
3675
+	 * This prepares the content of the messenger meta box admin settings
3676
+	 *
3677
+	 * @param  EE_messenger $messenger The messenger we're setting up content for
3678
+	 * @return string html formatted content
3679
+	 * @throws DomainException
3680
+	 */
3681
+	protected function _get_messenger_box_content(EE_messenger $messenger)
3682
+	{
3683
+
3684
+		$fields = $messenger->get_admin_settings_fields();
3685
+		$settings_template_args['template_form_fields'] = '';
3686
+
3687
+		// is $messenger active?
3688
+		$settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
3689
+
3690
+
3691
+		if (! empty($fields)) {
3692
+			$existing_settings = $messenger->get_existing_admin_settings();
3693
+
3694
+			foreach ($fields as $fldname => $fldprops) {
3695
+				$field_id = $messenger->name . '-' . $fldname;
3696
+				$template_form_field[ $field_id ] = array(
3697
+					'name'       => 'messenger_settings[' . $field_id . ']',
3698
+					'label'      => $fldprops['label'],
3699
+					'input'      => $fldprops['field_type'],
3700
+					'type'       => $fldprops['value_type'],
3701
+					'required'   => $fldprops['required'],
3702
+					'validation' => $fldprops['validation'],
3703
+					'value'      => isset($existing_settings[ $field_id ])
3704
+						? $existing_settings[ $field_id ]
3705
+						: $fldprops['default'],
3706
+					'css_class'  => '',
3707
+					'format'     => $fldprops['format'],
3708
+				);
3709
+			}
3710
+
3711
+
3712
+			$settings_template_args['template_form_fields'] = ! empty($template_form_field)
3713
+				? $this->_generate_admin_form_fields($template_form_field, 'string', 'ee_m_activate_form')
3714
+				: '';
3715
+		}
3716
+
3717
+		// we also need some hidden fields
3718
+		$settings_template_args['hidden_fields'] = array(
3719
+			'messenger_settings[messenger]' => array(
3720
+				'type'  => 'hidden',
3721
+				'value' => $messenger->name,
3722
+			),
3723
+			'type'                          => array(
3724
+				'type'  => 'hidden',
3725
+				'value' => 'messenger',
3726
+			),
3727
+		);
3728
+
3729
+		// make sure any active message types that are existing are included in the hidden fields
3730
+		if (isset($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'])) {
3731
+			foreach ($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'] as $mt => $values) {
3732
+				$settings_template_args['hidden_fields'][ 'messenger_settings[message_types][' . $mt . ']' ] = array(
3733
+					'type'  => 'hidden',
3734
+					'value' => $mt,
3735
+				);
3736
+			}
3737
+		}
3738
+		$settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
3739
+			$settings_template_args['hidden_fields'],
3740
+			'array'
3741
+		);
3742
+		$active = $this->_message_resource_manager->is_messenger_active($messenger->name);
3743
+
3744
+		$settings_template_args['messenger'] = $messenger->name;
3745
+		$settings_template_args['description'] = $messenger->description;
3746
+		$settings_template_args['show_hide_edit_form'] = $active ? '' : ' hidden';
3747
+
3748
+
3749
+		$settings_template_args['show_hide_edit_form'] = $this->_message_resource_manager->is_messenger_active(
3750
+			$messenger->name
3751
+		)
3752
+			? $settings_template_args['show_hide_edit_form']
3753
+			: ' hidden';
3754
+
3755
+		$settings_template_args['show_hide_edit_form'] = empty($settings_template_args['template_form_fields'])
3756
+			? ' hidden'
3757
+			: $settings_template_args['show_hide_edit_form'];
3758
+
3759
+
3760
+		$settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
3761
+		$settings_template_args['nonce'] = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
3762
+		$settings_template_args['on_off_status'] = $active ? true : false;
3763
+		$template = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
3764
+		$content = EEH_Template::display_template(
3765
+			$template,
3766
+			$settings_template_args,
3767
+			true
3768
+		);
3769
+
3770
+		return $content;
3771
+	}
3772
+
3773
+
3774
+	/**
3775
+	 * used by ajax on the messages settings page to activate|deactivate the messenger
3776
+	 *
3777
+	 * @throws DomainException
3778
+	 * @throws EE_Error
3779
+	 * @throws InvalidDataTypeException
3780
+	 * @throws InvalidInterfaceException
3781
+	 * @throws InvalidArgumentException
3782
+	 * @throws ReflectionException
3783
+	 */
3784
+	public function activate_messenger_toggle()
3785
+	{
3786
+		$success = true;
3787
+		$this->_prep_default_response_for_messenger_or_message_type_toggle();
3788
+		// let's check that we have required data
3789
+		if (! isset($this->_req_data['messenger'])) {
3790
+			EE_Error::add_error(
3791
+				esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
3792
+				__FILE__,
3793
+				__FUNCTION__,
3794
+				__LINE__
3795
+			);
3796
+			$success = false;
3797
+		}
3798
+
3799
+		// do a nonce check here since we're not arriving via a normal route
3800
+		$nonce = isset($this->_req_data['activate_nonce'])
3801
+			? sanitize_text_field($this->_req_data['activate_nonce'])
3802
+			: '';
3803
+		$nonce_ref = 'activate_' . $this->_req_data['messenger'] . '_toggle_nonce';
3804
+
3805
+		$this->_verify_nonce($nonce, $nonce_ref);
3806
+
3807
+
3808
+		if (! isset($this->_req_data['status'])) {
3809
+			EE_Error::add_error(
3810
+				esc_html__(
3811
+					'Messenger status needed to know whether activation or deactivation is happening. No status is given',
3812
+					'event_espresso'
3813
+				),
3814
+				__FILE__,
3815
+				__FUNCTION__,
3816
+				__LINE__
3817
+			);
3818
+			$success = false;
3819
+		}
3820
+
3821
+		// do check to verify we have a valid status.
3822
+		$status = $this->_req_data['status'];
3823
+
3824
+		if ($status !== 'off' && $status !== 'on') {
3825
+			EE_Error::add_error(
3826
+				sprintf(
3827
+					esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
3828
+					$this->_req_data['status']
3829
+				),
3830
+				__FILE__,
3831
+				__FUNCTION__,
3832
+				__LINE__
3833
+			);
3834
+			$success = false;
3835
+		}
3836
+
3837
+		if ($success) {
3838
+			// made it here?  Stop dawdling then!!
3839
+			$success = $status === 'off'
3840
+				? $this->_deactivate_messenger($this->_req_data['messenger'])
3841
+				: $this->_activate_messenger($this->_req_data['messenger']);
3842
+		}
3843
+
3844
+		$this->_template_args['success'] = $success;
3845
+
3846
+		// no special instructions so let's just do the json return (which should automatically do all the special stuff).
3847
+		$this->_return_json();
3848
+	}
3849
+
3850
+
3851
+	/**
3852
+	 * used by ajax from the messages settings page to activate|deactivate a message type
3853
+	 *
3854
+	 * @throws DomainException
3855
+	 * @throws EE_Error
3856
+	 * @throws ReflectionException
3857
+	 * @throws InvalidDataTypeException
3858
+	 * @throws InvalidInterfaceException
3859
+	 * @throws InvalidArgumentException
3860
+	 */
3861
+	public function activate_mt_toggle()
3862
+	{
3863
+		$success = true;
3864
+		$this->_prep_default_response_for_messenger_or_message_type_toggle();
3865
+
3866
+		// let's make sure we have the necessary data
3867
+		if (! isset($this->_req_data['message_type'])) {
3868
+			EE_Error::add_error(
3869
+				esc_html__('Message Type name needed to toggle activation. None given', 'event_espresso'),
3870
+				__FILE__,
3871
+				__FUNCTION__,
3872
+				__LINE__
3873
+			);
3874
+			$success = false;
3875
+		}
3876
+
3877
+		if (! isset($this->_req_data['messenger'])) {
3878
+			EE_Error::add_error(
3879
+				esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
3880
+				__FILE__,
3881
+				__FUNCTION__,
3882
+				__LINE__
3883
+			);
3884
+			$success = false;
3885
+		}
3886
+
3887
+		if (! isset($this->_req_data['status'])) {
3888
+			EE_Error::add_error(
3889
+				esc_html__(
3890
+					'Messenger status needed to know whether activation or deactivation is happening. No status is given',
3891
+					'event_espresso'
3892
+				),
3893
+				__FILE__,
3894
+				__FUNCTION__,
3895
+				__LINE__
3896
+			);
3897
+			$success = false;
3898
+		}
3899
+
3900
+
3901
+		// do check to verify we have a valid status.
3902
+		$status = $this->_req_data['status'];
3903
+
3904
+		if ($status !== 'activate' && $status !== 'deactivate') {
3905
+			EE_Error::add_error(
3906
+				sprintf(
3907
+					esc_html__('The given status (%s) is not valid. Must be "active" or "inactive"', 'event_espresso'),
3908
+					$this->_req_data['status']
3909
+				),
3910
+				__FILE__,
3911
+				__FUNCTION__,
3912
+				__LINE__
3913
+			);
3914
+			$success = false;
3915
+		}
3916
+
3917
+
3918
+		// do a nonce check here since we're not arriving via a normal route
3919
+		$nonce = isset($this->_req_data['mt_nonce']) ? sanitize_text_field($this->_req_data['mt_nonce']) : '';
3920
+		$nonce_ref = $this->_req_data['message_type'] . '_nonce';
3921
+
3922
+		$this->_verify_nonce($nonce, $nonce_ref);
3923
+
3924
+		if ($success) {
3925
+			// made it here? um, what are you waiting for then?
3926
+			$success = $status === 'deactivate'
3927
+				? $this->_deactivate_message_type_for_messenger(
3928
+					$this->_req_data['messenger'],
3929
+					$this->_req_data['message_type']
3930
+				)
3931
+				: $this->_activate_message_type_for_messenger(
3932
+					$this->_req_data['messenger'],
3933
+					$this->_req_data['message_type']
3934
+				);
3935
+		}
3936
+
3937
+		$this->_template_args['success'] = $success;
3938
+		$this->_return_json();
3939
+	}
3940
+
3941
+
3942
+	/**
3943
+	 * Takes care of processing activating a messenger and preparing the appropriate response.
3944
+	 *
3945
+	 * @param string $messenger_name The name of the messenger being activated
3946
+	 * @return bool
3947
+	 * @throws DomainException
3948
+	 * @throws EE_Error
3949
+	 * @throws InvalidArgumentException
3950
+	 * @throws ReflectionException
3951
+	 * @throws InvalidDataTypeException
3952
+	 * @throws InvalidInterfaceException
3953
+	 */
3954
+	protected function _activate_messenger($messenger_name)
3955
+	{
3956
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
3957
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
3958
+		$message_types_to_activate = $active_messenger instanceof EE_Messenger
3959
+			? $active_messenger->get_default_message_types()
3960
+			: array();
3961
+
3962
+		// ensure is active
3963
+		$this->_message_resource_manager->activate_messenger($messenger_name, $message_types_to_activate);
3964
+
3965
+		// set response_data for reload
3966
+		foreach ($message_types_to_activate as $message_type_name) {
3967
+			/** @var EE_message_type $message_type */
3968
+			$message_type = $this->_message_resource_manager->get_message_type($message_type_name);
3969
+			if ($this->_message_resource_manager->is_message_type_active_for_messenger(
3970
+				$messenger_name,
3971
+				$message_type_name
3972
+			)
3973
+				&& $message_type instanceof EE_message_type
3974
+			) {
3975
+				$this->_template_args['data']['active_mts'][] = $message_type_name;
3976
+				if ($message_type->get_admin_settings_fields()) {
3977
+					$this->_template_args['data']['mt_reload'][] = $message_type_name;
3978
+				}
3979
+			}
3980
+		}
3981
+
3982
+		// add success message for activating messenger
3983
+		return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger);
3984
+	}
3985
+
3986
+
3987
+	/**
3988
+	 * Takes care of processing deactivating a messenger and preparing the appropriate response.
3989
+	 *
3990
+	 * @param string $messenger_name The name of the messenger being activated
3991
+	 * @return bool
3992
+	 * @throws DomainException
3993
+	 * @throws EE_Error
3994
+	 * @throws InvalidArgumentException
3995
+	 * @throws ReflectionException
3996
+	 * @throws InvalidDataTypeException
3997
+	 * @throws InvalidInterfaceException
3998
+	 */
3999
+	protected function _deactivate_messenger($messenger_name)
4000
+	{
4001
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
4002
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
4003
+		$this->_message_resource_manager->deactivate_messenger($messenger_name);
4004
+
4005
+		return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger);
4006
+	}
4007
+
4008
+
4009
+	/**
4010
+	 * Takes care of processing activating a message type for a messenger and preparing the appropriate response.
4011
+	 *
4012
+	 * @param string $messenger_name    The name of the messenger the message type is being activated for.
4013
+	 * @param string $message_type_name The name of the message type being activated for the messenger
4014
+	 * @return bool
4015
+	 * @throws DomainException
4016
+	 * @throws EE_Error
4017
+	 * @throws InvalidArgumentException
4018
+	 * @throws ReflectionException
4019
+	 * @throws InvalidDataTypeException
4020
+	 * @throws InvalidInterfaceException
4021
+	 */
4022
+	protected function _activate_message_type_for_messenger($messenger_name, $message_type_name)
4023
+	{
4024
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
4025
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
4026
+		/** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
4027
+		$message_type_to_activate = $this->_message_resource_manager->get_message_type($message_type_name);
4028
+
4029
+		// ensure is active
4030
+		$this->_message_resource_manager->activate_messenger($messenger_name, $message_type_name);
4031
+
4032
+		// set response for load
4033
+		if ($this->_message_resource_manager->is_message_type_active_for_messenger(
4034
+			$messenger_name,
4035
+			$message_type_name
4036
+		)
4037
+		) {
4038
+			$this->_template_args['data']['active_mts'][] = $message_type_name;
4039
+			if ($message_type_to_activate->get_admin_settings_fields()) {
4040
+				$this->_template_args['data']['mt_reload'][] = $message_type_name;
4041
+			}
4042
+		}
4043
+
4044
+		return $this->_setup_response_message_for_activating_messenger_with_message_types(
4045
+			$active_messenger,
4046
+			$message_type_to_activate
4047
+		);
4048
+	}
4049
+
4050
+
4051
+	/**
4052
+	 * Takes care of processing deactivating a message type for a messenger and preparing the appropriate response.
4053
+	 *
4054
+	 * @param string $messenger_name    The name of the messenger the message type is being deactivated for.
4055
+	 * @param string $message_type_name The name of the message type being deactivated for the messenger
4056
+	 * @return bool
4057
+	 * @throws DomainException
4058
+	 * @throws EE_Error
4059
+	 * @throws InvalidArgumentException
4060
+	 * @throws ReflectionException
4061
+	 * @throws InvalidDataTypeException
4062
+	 * @throws InvalidInterfaceException
4063
+	 */
4064
+	protected function _deactivate_message_type_for_messenger($messenger_name, $message_type_name)
4065
+	{
4066
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
4067
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
4068
+		/** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
4069
+		$message_type_to_deactivate = $this->_message_resource_manager->get_message_type($message_type_name);
4070
+		$this->_message_resource_manager->deactivate_message_type_for_messenger($message_type_name, $messenger_name);
4071
+
4072
+		return $this->_setup_response_message_for_deactivating_messenger_with_message_types(
4073
+			$active_messenger,
4074
+			$message_type_to_deactivate
4075
+		);
4076
+	}
4077
+
4078
+
4079
+	/**
4080
+	 * This just initializes the defaults for activating messenger and message type responses.
4081
+	 */
4082
+	protected function _prep_default_response_for_messenger_or_message_type_toggle()
4083
+	{
4084
+		$this->_template_args['data']['active_mts'] = array();
4085
+		$this->_template_args['data']['mt_reload'] = array();
4086
+	}
4087
+
4088
+
4089
+	/**
4090
+	 * Setup appropriate response for activating a messenger and/or message types
4091
+	 *
4092
+	 * @param EE_messenger         $messenger
4093
+	 * @param EE_message_type|null $message_type
4094
+	 * @return bool
4095
+	 * @throws DomainException
4096
+	 * @throws EE_Error
4097
+	 * @throws InvalidArgumentException
4098
+	 * @throws ReflectionException
4099
+	 * @throws InvalidDataTypeException
4100
+	 * @throws InvalidInterfaceException
4101
+	 */
4102
+	protected function _setup_response_message_for_activating_messenger_with_message_types(
4103
+		$messenger,
4104
+		EE_Message_Type $message_type = null
4105
+	) {
4106
+		// if $messenger isn't a valid messenger object then get out.
4107
+		if (! $messenger instanceof EE_Messenger) {
4108
+			EE_Error::add_error(
4109
+				esc_html__('The messenger being activated is not a valid messenger', 'event_espresso'),
4110
+				__FILE__,
4111
+				__FUNCTION__,
4112
+				__LINE__
4113
+			);
4114
+
4115
+			return false;
4116
+		}
4117
+		// activated
4118
+		if ($this->_template_args['data']['active_mts']) {
4119
+			EE_Error::overwrite_success();
4120
+			// activated a message type with the messenger
4121
+			if ($message_type instanceof EE_message_type) {
4122
+				EE_Error::add_success(
4123
+					sprintf(
4124
+						esc_html__(
4125
+							'%s message type has been successfully activated with the %s messenger',
4126
+							'event_espresso'
4127
+						),
4128
+						ucwords($message_type->label['singular']),
4129
+						ucwords($messenger->label['singular'])
4130
+					)
4131
+				);
4132
+
4133
+				// if message type was invoice then let's make sure we activate the invoice payment method.
4134
+				if ($message_type->name === 'invoice') {
4135
+					EE_Registry::instance()->load_lib('Payment_Method_Manager');
4136
+					$pm = EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
4137
+					if ($pm instanceof EE_Payment_Method) {
4138
+						EE_Error::add_attention(
4139
+							esc_html__(
4140
+								'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.',
4141
+								'event_espresso'
4142
+							)
4143
+						);
4144
+					}
4145
+				}
4146
+				// just toggles the entire messenger
4147
+			} else {
4148
+				EE_Error::add_success(
4149
+					sprintf(
4150
+						esc_html__('%s messenger has been successfully activated', 'event_espresso'),
4151
+						ucwords($messenger->label['singular'])
4152
+					)
4153
+				);
4154
+			}
4155
+
4156
+			return true;
4157
+
4158
+			// possible error condition. This will happen when our active_mts data is empty because it is validated for actual active
4159
+			// message types after the activation process.  However its possible some messengers don't HAVE any default_message_types
4160
+			// in which case we just give a success message for the messenger being successfully activated.
4161
+		} else {
4162
+			if (! $messenger->get_default_message_types()) {
4163
+				// messenger doesn't have any default message types so still a success.
4164
+				EE_Error::add_success(
4165
+					sprintf(
4166
+						esc_html__('%s messenger was successfully activated.', 'event_espresso'),
4167
+						ucwords($messenger->label['singular'])
4168
+					)
4169
+				);
4170
+
4171
+				return true;
4172
+			} else {
4173
+				EE_Error::add_error(
4174
+					$message_type instanceof EE_message_type
4175
+						? sprintf(
4176
+							esc_html__(
4177
+								'%s message type was not successfully activated with the %s messenger',
4178
+								'event_espresso'
4179
+							),
4180
+							ucwords($message_type->label['singular']),
4181
+							ucwords($messenger->label['singular'])
4182
+						)
4183
+						: sprintf(
4184
+							esc_html__('%s messenger was not successfully activated', 'event_espresso'),
4185
+							ucwords($messenger->label['singular'])
4186
+						),
4187
+					__FILE__,
4188
+					__FUNCTION__,
4189
+					__LINE__
4190
+				);
4191
+
4192
+				return false;
4193
+			}
4194
+		}
4195
+	}
4196
+
4197
+
4198
+	/**
4199
+	 * This sets up the appropriate response for deactivating a messenger and/or message type.
4200
+	 *
4201
+	 * @param EE_messenger         $messenger
4202
+	 * @param EE_message_type|null $message_type
4203
+	 * @return bool
4204
+	 * @throws DomainException
4205
+	 * @throws EE_Error
4206
+	 * @throws InvalidArgumentException
4207
+	 * @throws ReflectionException
4208
+	 * @throws InvalidDataTypeException
4209
+	 * @throws InvalidInterfaceException
4210
+	 */
4211
+	protected function _setup_response_message_for_deactivating_messenger_with_message_types(
4212
+		$messenger,
4213
+		EE_message_type $message_type = null
4214
+	) {
4215
+		EE_Error::overwrite_success();
4216
+
4217
+		// if $messenger isn't a valid messenger object then get out.
4218
+		if (! $messenger instanceof EE_Messenger) {
4219
+			EE_Error::add_error(
4220
+				esc_html__('The messenger being deactivated is not a valid messenger', 'event_espresso'),
4221
+				__FILE__,
4222
+				__FUNCTION__,
4223
+				__LINE__
4224
+			);
4225
+
4226
+			return false;
4227
+		}
4228
+
4229
+		if ($message_type instanceof EE_message_type) {
4230
+			$message_type_name = $message_type->name;
4231
+			EE_Error::add_success(
4232
+				sprintf(
4233
+					esc_html__(
4234
+						'%s message type has been successfully deactivated for the %s messenger.',
4235
+						'event_espresso'
4236
+					),
4237
+					ucwords($message_type->label['singular']),
4238
+					ucwords($messenger->label['singular'])
4239
+				)
4240
+			);
4241
+		} else {
4242
+			$message_type_name = '';
4243
+			EE_Error::add_success(
4244
+				sprintf(
4245
+					esc_html__('%s messenger has been successfully deactivated.', 'event_espresso'),
4246
+					ucwords($messenger->label['singular'])
4247
+				)
4248
+			);
4249
+		}
4250
+
4251
+		// if messenger was html or message type was invoice then let's make sure we deactivate invoice payment method.
4252
+		if ($messenger->name === 'html' || $message_type_name === 'invoice') {
4253
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
4254
+			$count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method('invoice');
4255
+			if ($count_updated > 0) {
4256
+				$msg = $message_type_name === 'invoice'
4257
+					? esc_html__(
4258
+						'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.',
4259
+						'event_espresso'
4260
+					)
4261
+					: esc_html__(
4262
+						'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.',
4263
+						'event_espresso'
4264
+					);
4265
+				EE_Error::add_attention($msg);
4266
+			}
4267
+		}
4268
+
4269
+		return true;
4270
+	}
4271
+
4272
+
4273
+	/**
4274
+	 * handles updating a message type form on messenger activation IF the message type has settings fields. (via ajax)
4275
+	 *
4276
+	 * @throws DomainException
4277
+	 */
4278
+	public function update_mt_form()
4279
+	{
4280
+		if (! isset($this->_req_data['messenger']) || ! isset($this->_req_data['message_type'])) {
4281
+			EE_Error::add_error(
4282
+				esc_html__('Require message type or messenger to send an updated form', 'event_espresso'),
4283
+				__FILE__,
4284
+				__FUNCTION__,
4285
+				__LINE__
4286
+			);
4287
+			$this->_return_json();
4288
+		}
4289
+
4290
+		$message_types = $this->get_installed_message_types();
4291
+
4292
+		$message_type = $message_types[ $this->_req_data['message_type'] ];
4293
+		$messenger = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
4294
+
4295
+		$content = $this->_message_type_settings_content(
4296
+			$message_type,
4297
+			$messenger,
4298
+			true
4299
+		);
4300
+		$this->_template_args['success'] = true;
4301
+		$this->_template_args['content'] = $content;
4302
+		$this->_return_json();
4303
+	}
4304
+
4305
+
4306
+	/**
4307
+	 * this handles saving the settings for a messenger or message type
4308
+	 *
4309
+	 */
4310
+	public function save_settings()
4311
+	{
4312
+		if (! isset($this->_req_data['type'])) {
4313
+			EE_Error::add_error(
4314
+				esc_html__(
4315
+					'Cannot save settings because type is unknown (messenger settings or messsage type settings?)',
4316
+					'event_espresso'
4317
+				),
4318
+				__FILE__,
4319
+				__FUNCTION__,
4320
+				__LINE__
4321
+			);
4322
+			$this->_template_args['error'] = true;
4323
+			$this->_return_json();
4324
+		}
4325
+
4326
+
4327
+		if ($this->_req_data['type'] === 'messenger') {
4328
+			// this should be an array.
4329
+			$settings = $this->_req_data['messenger_settings'];
4330
+			$messenger = $settings['messenger'];
4331
+			// let's setup the settings data
4332
+			foreach ($settings as $key => $value) {
4333
+				switch ($key) {
4334
+					case 'messenger':
4335
+						unset($settings['messenger']);
4336
+						break;
4337
+					case 'message_types':
4338
+						unset($settings['message_types']);
4339
+						break;
4340
+					default:
4341
+						$settings[ $key ] = $value;
4342
+						break;
4343
+				}
4344
+			}
4345
+			$this->_message_resource_manager->add_settings_for_messenger($messenger, $settings);
4346
+		} elseif ($this->_req_data['type'] === 'message_type') {
4347
+			$settings = $this->_req_data['message_type_settings'];
4348
+			$messenger = $settings['messenger'];
4349
+			$message_type = $settings['message_type'];
4350
+
4351
+			foreach ($settings as $key => $value) {
4352
+				switch ($key) {
4353
+					case 'messenger':
4354
+						unset($settings['messenger']);
4355
+						break;
4356
+					case 'message_type':
4357
+						unset($settings['message_type']);
4358
+						break;
4359
+					default:
4360
+						$settings[ $key ] = $value;
4361
+						break;
4362
+				}
4363
+			}
4364
+
4365
+			$this->_message_resource_manager->add_settings_for_message_type($messenger, $message_type, $settings);
4366
+		}
4367
+
4368
+		// okay we should have the data all setup.  Now we just update!
4369
+		$success = $this->_message_resource_manager->update_active_messengers_option();
4370
+
4371
+		if ($success) {
4372
+			EE_Error::add_success(__('Settings updated', 'event_espresso'));
4373
+		} else {
4374
+			EE_Error::add_error(
4375
+				esc_html__(
4376
+					'Settings did not get updated',
4377
+					'event_espresso'
4378
+				),
4379
+				__FILE__,
4380
+				__FUNCTION__,
4381
+				__LINE__
4382
+			);
4383
+		}
4384
+
4385
+		$this->_template_args['success'] = $success;
4386
+		$this->_return_json();
4387
+	}
4388
+
4389
+
4390
+
4391
+
4392
+	/**  EE MESSAGE PROCESSING ACTIONS **/
4393
+
4394
+
4395
+	/**
4396
+	 * This immediately generates any EE_Message ID's that are selected that are EEM_Message::status_incomplete
4397
+	 * However, this does not send immediately, it just queues for sending.
4398
+	 *
4399
+	 * @since 4.9.0
4400
+	 * @throws EE_Error
4401
+	 * @throws InvalidDataTypeException
4402
+	 * @throws InvalidInterfaceException
4403
+	 * @throws InvalidArgumentException
4404
+	 * @throws ReflectionException
4405
+	 */
4406
+	protected function _generate_now()
4407
+	{
4408
+		EED_Messages::generate_now($this->_get_msg_ids_from_request());
4409
+		$this->_redirect_after_action(false, '', '', array(), true);
4410
+	}
4411
+
4412
+
4413
+	/**
4414
+	 * This immediately generates AND sends any EE_Message's selected that are EEM_Message::status_incomplete or that
4415
+	 * are EEM_Message::status_resend or EEM_Message::status_idle
4416
+	 *
4417
+	 * @since 4.9.0
4418
+	 * @throws EE_Error
4419
+	 * @throws InvalidDataTypeException
4420
+	 * @throws InvalidInterfaceException
4421
+	 * @throws InvalidArgumentException
4422
+	 * @throws ReflectionException
4423
+	 */
4424
+	protected function _generate_and_send_now()
4425
+	{
4426
+		EED_Messages::generate_and_send_now($this->_get_msg_ids_from_request());
4427
+		$this->_redirect_after_action(false, '', '', array(), true);
4428
+	}
4429
+
4430
+
4431
+	/**
4432
+	 * This queues any EEM_Message::status_sent EE_Message ids in the request for resending.
4433
+	 *
4434
+	 * @since 4.9.0
4435
+	 * @throws EE_Error
4436
+	 * @throws InvalidDataTypeException
4437
+	 * @throws InvalidInterfaceException
4438
+	 * @throws InvalidArgumentException
4439
+	 * @throws ReflectionException
4440
+	 */
4441
+	protected function _queue_for_resending()
4442
+	{
4443
+		EED_Messages::queue_for_resending($this->_get_msg_ids_from_request());
4444
+		$this->_redirect_after_action(false, '', '', array(), true);
4445
+	}
4446
+
4447
+
4448
+	/**
4449
+	 *  This sends immediately any EEM_Message::status_idle or EEM_Message::status_resend messages in the queue
4450
+	 *
4451
+	 * @since 4.9.0
4452
+	 * @throws EE_Error
4453
+	 * @throws InvalidDataTypeException
4454
+	 * @throws InvalidInterfaceException
4455
+	 * @throws InvalidArgumentException
4456
+	 * @throws ReflectionException
4457
+	 */
4458
+	protected function _send_now()
4459
+	{
4460
+		EED_Messages::send_now($this->_get_msg_ids_from_request());
4461
+		$this->_redirect_after_action(false, '', '', array(), true);
4462
+	}
4463
+
4464
+
4465
+	/**
4466
+	 * Deletes EE_messages for IDs in the request.
4467
+	 *
4468
+	 * @since 4.9.0
4469
+	 * @throws EE_Error
4470
+	 * @throws InvalidDataTypeException
4471
+	 * @throws InvalidInterfaceException
4472
+	 * @throws InvalidArgumentException
4473
+	 */
4474
+	protected function _delete_ee_messages()
4475
+	{
4476
+		$msg_ids = $this->_get_msg_ids_from_request();
4477
+		$deleted_count = 0;
4478
+		foreach ($msg_ids as $msg_id) {
4479
+			if (EEM_Message::instance()->delete_by_ID($msg_id)) {
4480
+				$deleted_count++;
4481
+			}
4482
+		}
4483
+		if ($deleted_count) {
4484
+			EE_Error::add_success(
4485
+				esc_html(
4486
+					_n(
4487
+						'Message successfully deleted',
4488
+						'Messages successfully deleted',
4489
+						$deleted_count,
4490
+						'event_espresso'
4491
+					)
4492
+				)
4493
+			);
4494
+			$this->_redirect_after_action(
4495
+				false,
4496
+				'',
4497
+				'',
4498
+				array(),
4499
+				true
4500
+			);
4501
+		} else {
4502
+			EE_Error::add_error(
4503
+				_n('The message was not deleted.', 'The messages were not deleted', count($msg_ids), 'event_espresso'),
4504
+				__FILE__,
4505
+				__FUNCTION__,
4506
+				__LINE__
4507
+			);
4508
+			$this->_redirect_after_action(false, '', '', array(), true);
4509
+		}
4510
+	}
4511
+
4512
+
4513
+	/**
4514
+	 *  This looks for 'MSG_ID' key in the request and returns an array of MSG_ID's if present.
4515
+	 *
4516
+	 * @since 4.9.0
4517
+	 * @return array
4518
+	 */
4519
+	protected function _get_msg_ids_from_request()
4520
+	{
4521
+		if (! isset($this->_req_data['MSG_ID'])) {
4522
+			return array();
4523
+		}
4524
+
4525
+		return is_array($this->_req_data['MSG_ID'])
4526
+			? array_keys($this->_req_data['MSG_ID'])
4527
+			: array($this->_req_data['MSG_ID']);
4528
+	}
4529 4529
 }
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
             'sent_status'                => array(
1080
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent,
1080
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_sent,
1081 1081
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, 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
             'failed_status'              => array(
1088
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
1088
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_failed,
1089 1089
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, 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
             'resend_status'              => array(
1096
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend,
1096
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_resend,
1097 1097
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence'),
1098 1098
             ),
1099 1099
             'incomplete_status'          => array(
1100
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
1100
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_incomplete,
1101 1101
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence'),
1102 1102
             ),
1103 1103
             'retry_status'               => array(
1104
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry,
1104
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_retry,
1105 1105
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, 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;
@@ -1348,7 +1348,7 @@  discard block
 block discarded – undo
1348 1348
         // we need to assemble the title from Various details
1349 1349
         $context_label = sprintf(
1350 1350
             esc_html__('(%s %s)', 'event_espresso'),
1351
-            $c_config[ $context ]['label'],
1351
+            $c_config[$context]['label'],
1352 1352
             ucwords($c_label['label'])
1353 1353
         );
1354 1354
 
@@ -1370,7 +1370,7 @@  discard block
 block discarded – undo
1370 1370
             $message_template_group->message_type()
1371 1371
         );
1372 1372
 
1373
-        if (! $template_field_structure) {
1373
+        if ( ! $template_field_structure) {
1374 1374
             $template_field_structure = false;
1375 1375
             $template_fields = esc_html__(
1376 1376
                 'There was an error in assembling the fields for this display (you should see an error message)',
@@ -1384,21 +1384,21 @@  discard block
 block discarded – undo
1384 1384
 
1385 1385
         // if we have the extra key.. then we need to remove the content index from the template_field_structure as it
1386 1386
         // will get handled in the "extra" array.
1387
-        if (is_array($template_field_structure[ $context ]) && isset($template_field_structure[ $context ]['extra'])) {
1388
-            foreach ($template_field_structure[ $context ]['extra'] as $reference_field => $new_fields) {
1389
-                unset($template_field_structure[ $context ][ $reference_field ]);
1387
+        if (is_array($template_field_structure[$context]) && isset($template_field_structure[$context]['extra'])) {
1388
+            foreach ($template_field_structure[$context]['extra'] as $reference_field => $new_fields) {
1389
+                unset($template_field_structure[$context][$reference_field]);
1390 1390
             }
1391 1391
         }
1392 1392
 
1393 1393
         // let's loop through the template_field_structure and actually assemble the input fields!
1394
-        if (! empty($template_field_structure)) {
1395
-            foreach ($template_field_structure[ $context ] as $template_field => $field_setup_array) {
1394
+        if ( ! empty($template_field_structure)) {
1395
+            foreach ($template_field_structure[$context] as $template_field => $field_setup_array) {
1396 1396
                 // if this is an 'extra' template field then we need to remove any existing fields that are keyed up in
1397 1397
                 // the extra array and reset them.
1398 1398
                 if ($template_field === 'extra') {
1399 1399
                     $this->_template_args['is_extra_fields'] = true;
1400 1400
                     foreach ($field_setup_array as $reference_field => $new_fields_array) {
1401
-                        $message_template = $message_templates[ $context ][ $reference_field ];
1401
+                        $message_template = $message_templates[$context][$reference_field];
1402 1402
                         $content = $message_template instanceof EE_Message_Template
1403 1403
                             ? $message_template->get('MTP_content')
1404 1404
                             : '';
@@ -1407,7 +1407,7 @@  discard block
 block discarded – undo
1407 1407
                             $continue = false;
1408 1408
                             if (isset($extra_array['shortcodes_required'])) {
1409 1409
                                 foreach ((array) $extra_array['shortcodes_required'] as $shortcode) {
1410
-                                    if (! array_key_exists($shortcode, $this->_shortcodes)) {
1410
+                                    if ( ! array_key_exists($shortcode, $this->_shortcodes)) {
1411 1411
                                         $continue = true;
1412 1412
                                     }
1413 1413
                                 }
@@ -1420,57 +1420,57 @@  discard block
 block discarded – undo
1420 1420
                                         . '-'
1421 1421
                                         . $extra_field
1422 1422
                                         . '-content';
1423
-                            $template_form_fields[ $field_id ] = $extra_array;
1424
-                            $template_form_fields[ $field_id ]['name'] = 'MTP_template_fields['
1423
+                            $template_form_fields[$field_id] = $extra_array;
1424
+                            $template_form_fields[$field_id]['name'] = 'MTP_template_fields['
1425 1425
                                                                          . $reference_field
1426 1426
                                                                          . '][content]['
1427
-                                                                         . $extra_field . ']';
1427
+                                                                         . $extra_field.']';
1428 1428
                             $css_class = isset($extra_array['css_class'])
1429 1429
                                 ? $extra_array['css_class']
1430 1430
                                 : '';
1431 1431
 
1432
-                            $template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
1432
+                            $template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
1433 1433
                                                                               && in_array($extra_field, $v_fields, true)
1434 1434
                                                                               &&
1435 1435
                                                                               (
1436
-                                                                                  is_array($validators[ $extra_field ])
1437
-                                                                                  && isset($validators[ $extra_field ]['msg'])
1436
+                                                                                  is_array($validators[$extra_field])
1437
+                                                                                  && isset($validators[$extra_field]['msg'])
1438 1438
                                                                               )
1439
-                                ? 'validate-error ' . $css_class
1439
+                                ? 'validate-error '.$css_class
1440 1440
                                 : $css_class;
1441 1441
 
1442
-                            $template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
1443
-                                                                          && isset($content[ $extra_field ])
1444
-                                ? $content[ $extra_field ]
1442
+                            $template_form_fields[$field_id]['value'] = ! empty($message_templates)
1443
+                                                                          && isset($content[$extra_field])
1444
+                                ? $content[$extra_field]
1445 1445
                                 : '';
1446 1446
 
1447 1447
                             // do we have a validation error?  if we do then let's use that value instead
1448
-                            $template_form_fields[ $field_id ]['value'] = isset($validators[ $extra_field ])
1449
-                                ? $validators[ $extra_field ]['value']
1450
-                                : $template_form_fields[ $field_id ]['value'];
1448
+                            $template_form_fields[$field_id]['value'] = isset($validators[$extra_field])
1449
+                                ? $validators[$extra_field]['value']
1450
+                                : $template_form_fields[$field_id]['value'];
1451 1451
 
1452 1452
 
1453
-                            $template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
1453
+                            $template_form_fields[$field_id]['db-col'] = 'MTP_content';
1454 1454
 
1455 1455
                             // shortcode selector
1456 1456
                             $field_name_to_use = $extra_field === 'main'
1457 1457
                                 ? 'content'
1458 1458
                                 : $extra_field;
1459
-                            $template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
1459
+                            $template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector(
1460 1460
                                 $field_name_to_use,
1461 1461
                                 $field_id
1462 1462
                             );
1463 1463
 
1464 1464
                             if (isset($extra_array['input']) && $extra_array['input'] === 'wp_editor') {
1465 1465
                                 // we want to decode the entities
1466
-                                $template_form_fields[ $field_id ]['value'] = $template_form_fields[ $field_id ]['value'];
1466
+                                $template_form_fields[$field_id]['value'] = $template_form_fields[$field_id]['value'];
1467 1467
                             }/**/
1468 1468
                         }
1469
-                        $templatefield_MTP_id = $reference_field . '-MTP_ID';
1470
-                        $templatefield_templatename_id = $reference_field . '-name';
1469
+                        $templatefield_MTP_id = $reference_field.'-MTP_ID';
1470
+                        $templatefield_templatename_id = $reference_field.'-name';
1471 1471
 
1472
-                        $template_form_fields[ $templatefield_MTP_id ] = array(
1473
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
1472
+                        $template_form_fields[$templatefield_MTP_id] = array(
1473
+                            'name'       => 'MTP_template_fields['.$reference_field.'][MTP_ID]',
1474 1474
                             'label'      => null,
1475 1475
                             'input'      => 'hidden',
1476 1476
                             'type'       => 'int',
@@ -1482,8 +1482,8 @@  discard block
 block discarded – undo
1482 1482
                             'db-col'     => 'MTP_ID',
1483 1483
                         );
1484 1484
 
1485
-                        $template_form_fields[ $templatefield_templatename_id ] = array(
1486
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
1485
+                        $template_form_fields[$templatefield_templatename_id] = array(
1486
+                            'name'       => 'MTP_template_fields['.$reference_field.'][name]',
1487 1487
                             'label'      => null,
1488 1488
                             'input'      => 'hidden',
1489 1489
                             'type'       => 'string',
@@ -1497,36 +1497,36 @@  discard block
 block discarded – undo
1497 1497
                     }
1498 1498
                     continue; // skip the next stuff, we got the necessary fields here for this dataset.
1499 1499
                 } else {
1500
-                    $field_id = $template_field . '-content';
1501
-                    $template_form_fields[ $field_id ] = $field_setup_array;
1502
-                    $template_form_fields[ $field_id ]['name'] = 'MTP_template_fields[' . $template_field . '][content]';
1503
-                    $message_template = isset($message_templates[ $context ][ $template_field ])
1504
-                        ? $message_templates[ $context ][ $template_field ]
1500
+                    $field_id = $template_field.'-content';
1501
+                    $template_form_fields[$field_id] = $field_setup_array;
1502
+                    $template_form_fields[$field_id]['name'] = 'MTP_template_fields['.$template_field.'][content]';
1503
+                    $message_template = isset($message_templates[$context][$template_field])
1504
+                        ? $message_templates[$context][$template_field]
1505 1505
                         : null;
1506
-                    $template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
1507
-                                                                  && is_array($message_templates[ $context ])
1506
+                    $template_form_fields[$field_id]['value'] = ! empty($message_templates)
1507
+                                                                  && is_array($message_templates[$context])
1508 1508
                                                                   && $message_template instanceof EE_Message_Template
1509 1509
                         ? $message_template->get('MTP_content')
1510 1510
                         : '';
1511 1511
 
1512 1512
                     // do we have a validator error for this field?  if we do then we'll use that value instead
1513
-                    $template_form_fields[ $field_id ]['value'] = isset($validators[ $template_field ])
1514
-                        ? $validators[ $template_field ]['value']
1515
-                        : $template_form_fields[ $field_id ]['value'];
1513
+                    $template_form_fields[$field_id]['value'] = isset($validators[$template_field])
1514
+                        ? $validators[$template_field]['value']
1515
+                        : $template_form_fields[$field_id]['value'];
1516 1516
 
1517 1517
 
1518
-                    $template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
1518
+                    $template_form_fields[$field_id]['db-col'] = 'MTP_content';
1519 1519
                     $css_class = isset($field_setup_array['css_class'])
1520 1520
                         ? $field_setup_array['css_class']
1521 1521
                         : '';
1522
-                    $template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
1522
+                    $template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
1523 1523
                                                                       && in_array($template_field, $v_fields, true)
1524
-                                                                      && isset($validators[ $template_field ]['msg'])
1525
-                        ? 'validate-error ' . $css_class
1524
+                                                                      && isset($validators[$template_field]['msg'])
1525
+                        ? 'validate-error '.$css_class
1526 1526
                         : $css_class;
1527 1527
 
1528 1528
                     // shortcode selector
1529
-                    $template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
1529
+                    $template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector(
1530 1530
                         $template_field,
1531 1531
                         $field_id
1532 1532
                     );
@@ -1534,12 +1534,12 @@  discard block
 block discarded – undo
1534 1534
 
1535 1535
                 // k took care of content field(s) now let's take care of others.
1536 1536
 
1537
-                $templatefield_MTP_id = $template_field . '-MTP_ID';
1538
-                $templatefield_field_templatename_id = $template_field . '-name';
1537
+                $templatefield_MTP_id = $template_field.'-MTP_ID';
1538
+                $templatefield_field_templatename_id = $template_field.'-name';
1539 1539
 
1540 1540
                 // foreach template field there are actually two form fields created
1541
-                $template_form_fields[ $templatefield_MTP_id ] = array(
1542
-                    'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
1541
+                $template_form_fields[$templatefield_MTP_id] = array(
1542
+                    'name'       => 'MTP_template_fields['.$template_field.'][MTP_ID]',
1543 1543
                     'label'      => null,
1544 1544
                     'input'      => 'hidden',
1545 1545
                     'type'       => 'int',
@@ -1551,8 +1551,8 @@  discard block
 block discarded – undo
1551 1551
                     'db-col'     => 'MTP_ID',
1552 1552
                 );
1553 1553
 
1554
-                $template_form_fields[ $templatefield_field_templatename_id ] = array(
1555
-                    'name'       => 'MTP_template_fields[' . $template_field . '][name]',
1554
+                $template_form_fields[$templatefield_field_templatename_id] = array(
1555
+                    'name'       => 'MTP_template_fields['.$template_field.'][name]',
1556 1556
                     'label'      => null,
1557 1557
                     'input'      => 'hidden',
1558 1558
                     'type'       => 'string',
@@ -1695,10 +1695,10 @@  discard block
 block discarded – undo
1695 1695
                 'value' => $GRP_ID,
1696 1696
             );
1697 1697
             $sidebar_form_fields['ee-msg-evt-nonce'] = array(
1698
-                'name'  => $action . '_nonce',
1698
+                'name'  => $action.'_nonce',
1699 1699
                 'input' => 'hidden',
1700 1700
                 'type'  => 'string',
1701
-                'value' => wp_create_nonce($action . '_nonce'),
1701
+                'value' => wp_create_nonce($action.'_nonce'),
1702 1702
             );
1703 1703
 
1704 1704
             if (isset($this->_req_data['template_switch']) && $this->_req_data['template_switch']) {
@@ -1738,7 +1738,7 @@  discard block
 block discarded – undo
1738 1738
             ),
1739 1739
             $this->_admin_base_url
1740 1740
         );
1741
-        $preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">'
1741
+        $preview_button = '<a href="'.$preview_url.'" class="button-secondary messages-preview-button">'
1742 1742
                           . esc_html__('Preview', 'event_espresso')
1743 1743
                           . '</a>';
1744 1744
 
@@ -1775,7 +1775,7 @@  discard block
 block discarded – undo
1775 1775
 
1776 1776
         $this->_template_path = $this->_template_args['GRP_ID']
1777 1777
             ? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
1778
-            : EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
1778
+            : EE_MSG_TEMPLATE_PATH.'ee_msg_details_main_add_meta_box.template.php';
1779 1779
 
1780 1780
         // send along EE_Message_Template_Group object for further template use.
1781 1781
         $this->_template_args['MTP'] = $message_template_group;
@@ -1830,7 +1830,7 @@  discard block
 block discarded – undo
1830 1830
     ) {
1831 1831
         $template_args = array(
1832 1832
             'context'                   => $context,
1833
-            'nonce'                     => wp_create_nonce('activate_' . $context . '_toggle_nonce'),
1833
+            'nonce'                     => wp_create_nonce('activate_'.$context.'_toggle_nonce'),
1834 1834
             'is_active'                 => $message_template_group->is_context_active($context),
1835 1835
             'on_off_action'             => $message_template_group->is_context_active($context)
1836 1836
                 ? 'context-off'
@@ -1839,7 +1839,7 @@  discard block
 block discarded – undo
1839 1839
             'message_template_group_id' => $message_template_group->ID(),
1840 1840
         );
1841 1841
         return EEH_Template::display_template(
1842
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_editor_active_context_element.template.php',
1842
+            EE_MSG_TEMPLATE_PATH.'ee_msg_editor_active_context_element.template.php',
1843 1843
             $template_args,
1844 1844
             true
1845 1845
         );
@@ -1860,7 +1860,7 @@  discard block
 block discarded – undo
1860 1860
     {
1861 1861
         $success = true;
1862 1862
         // check for required data
1863
-        if (! isset(
1863
+        if ( ! isset(
1864 1864
             $this->_req_data['message_template_group_id'],
1865 1865
             $this->_req_data['context'],
1866 1866
             $this->_req_data['status']
@@ -1877,7 +1877,7 @@  discard block
 block discarded – undo
1877 1877
         $nonce = isset($this->_req_data['toggle_context_nonce'])
1878 1878
             ? sanitize_text_field($this->_req_data['toggle_context_nonce'])
1879 1879
             : '';
1880
-        $nonce_ref = 'activate_' . $this->_req_data['context'] . '_toggle_nonce';
1880
+        $nonce_ref = 'activate_'.$this->_req_data['context'].'_toggle_nonce';
1881 1881
         $this->_verify_nonce($nonce, $nonce_ref);
1882 1882
         $status = $this->_req_data['status'];
1883 1883
         if ($status !== 'off' && $status !== 'on') {
@@ -1895,7 +1895,7 @@  discard block
 block discarded – undo
1895 1895
         $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID(
1896 1896
             $this->_req_data['message_template_group_id']
1897 1897
         );
1898
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
1898
+        if ( ! $message_template_group instanceof EE_Message_Template_Group) {
1899 1899
             EE_Error::add_error(
1900 1900
                 sprintf(
1901 1901
                     esc_html__(
@@ -2024,7 +2024,7 @@  discard block
 block discarded – undo
2024 2024
         $templates = array();
2025 2025
         $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
2026 2026
         // we need to make sure we've got the info we need.
2027
-        if (! isset($this->_req_data['msgr'], $this->_req_data['mt'], $this->_req_data['GRP_ID'])) {
2027
+        if ( ! isset($this->_req_data['msgr'], $this->_req_data['mt'], $this->_req_data['GRP_ID'])) {
2028 2028
             EE_Error::add_error(
2029 2029
                 esc_html__(
2030 2030
                     '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.',
@@ -2066,7 +2066,7 @@  discard block
 block discarded – undo
2066 2066
         }
2067 2067
 
2068 2068
         // any error messages?
2069
-        if (! $success) {
2069
+        if ( ! $success) {
2070 2070
             EE_Error::add_error(
2071 2071
                 esc_html__(
2072 2072
                     'Something went wrong with deleting existing templates. Unable to reset to default',
@@ -2118,7 +2118,7 @@  discard block
 block discarded – undo
2118 2118
     public function _preview_message($send = false)
2119 2119
     {
2120 2120
         // first make sure we've got the necessary parameters
2121
-        if (! isset(
2121
+        if ( ! isset(
2122 2122
             $this->_req_data['message_type'],
2123 2123
             $this->_req_data['messenger'],
2124 2124
             $this->_req_data['messenger'],
@@ -2170,11 +2170,11 @@  discard block
 block discarded – undo
2170 2170
         $preview_title = sprintf(
2171 2171
             esc_html__('Viewing Preview for %s %s Message Template', 'event_espresso'),
2172 2172
             $active_messenger_label,
2173
-            ucwords($message_types[ $this->_req_data['message_type'] ]->label['singular'])
2173
+            ucwords($message_types[$this->_req_data['message_type']]->label['singular'])
2174 2174
         );
2175 2175
         // setup display of preview.
2176 2176
         $this->_admin_page_title = $preview_title;
2177
-        $this->_template_args['admin_page_content'] = $preview_button . '<br />' . $preview;
2177
+        $this->_template_args['admin_page_content'] = $preview_button.'<br />'.$preview;
2178 2178
         $this->_template_args['data']['force_json'] = true;
2179 2179
 
2180 2180
         return '';
@@ -2253,10 +2253,10 @@  discard block
 block discarded – undo
2253 2253
         foreach ($tp_collection as $tp) {
2254 2254
             // only include template packs that support this messenger and message type!
2255 2255
             $supports = $tp->get_supports();
2256
-            if (! isset($supports[ $this->_message_template_group->messenger() ])
2256
+            if ( ! isset($supports[$this->_message_template_group->messenger()])
2257 2257
                 || ! in_array(
2258 2258
                     $this->_message_template_group->message_type(),
2259
-                    $supports[ $this->_message_template_group->messenger() ],
2259
+                    $supports[$this->_message_template_group->messenger()],
2260 2260
                     true
2261 2261
                 )
2262 2262
             ) {
@@ -2309,7 +2309,7 @@  discard block
 block discarded – undo
2309 2309
         $template_args['template_pack_description'] = $template_pack_labels->template_pack_description;
2310 2310
         $template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
2311 2311
 
2312
-        $template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
2312
+        $template = EE_MSG_TEMPLATE_PATH.'template_pack_and_variations_metabox.template.php';
2313 2313
 
2314 2314
         EEH_Template::display_template($template, $template_args);
2315 2315
     }
@@ -2335,10 +2335,10 @@  discard block
 block discarded – undo
2335 2335
         // first we need to see if there are any fields
2336 2336
         $fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields();
2337 2337
 
2338
-        if (! empty($fields)) {
2338
+        if ( ! empty($fields)) {
2339 2339
             // yup there be fields
2340 2340
             foreach ($fields as $field => $config) {
2341
-                $field_id = $this->_message_template_group->messenger() . '_' . $field;
2341
+                $field_id = $this->_message_template_group->messenger().'_'.$field;
2342 2342
                 $existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
2343 2343
                 $default = isset($config['default']) ? $config['default'] : '';
2344 2344
                 $default = isset($config['value']) ? $config['value'] : $default;
@@ -2346,22 +2346,22 @@  discard block
 block discarded – undo
2346 2346
                 // if type is hidden and the value is empty
2347 2347
                 // something may have gone wrong so let's correct with the defaults
2348 2348
                 $fix = $config['input'] === 'hidden'
2349
-                       && isset($existing[ $field ])
2350
-                       && empty($existing[ $field ])
2349
+                       && isset($existing[$field])
2350
+                       && empty($existing[$field])
2351 2351
                     ? $default
2352 2352
                     : '';
2353
-                $existing[ $field ] = isset($existing[ $field ]) && empty($fix)
2354
-                    ? $existing[ $field ]
2353
+                $existing[$field] = isset($existing[$field]) && empty($fix)
2354
+                    ? $existing[$field]
2355 2355
                     : $fix;
2356 2356
 
2357
-                $template_form_fields[ $field_id ] = array(
2358
-                    'name'       => 'test_settings_fld[' . $field . ']',
2357
+                $template_form_fields[$field_id] = array(
2358
+                    'name'       => 'test_settings_fld['.$field.']',
2359 2359
                     'label'      => $config['label'],
2360 2360
                     'input'      => $config['input'],
2361 2361
                     'type'       => $config['type'],
2362 2362
                     'required'   => $config['required'],
2363 2363
                     'validation' => $config['validation'],
2364
-                    'value'      => isset($existing[ $field ]) ? $existing[ $field ] : $default,
2364
+                    'value'      => isset($existing[$field]) ? $existing[$field] : $default,
2365 2365
                     'css_class'  => $config['css_class'],
2366 2366
                     'options'    => isset($config['options']) ? $config['options'] : array(),
2367 2367
                     'default'    => $default,
@@ -2376,7 +2376,7 @@  discard block
 block discarded – undo
2376 2376
 
2377 2377
         $test_settings_html = '';
2378 2378
         // print out $test_settings_fields
2379
-        if (! empty($test_settings_fields)) {
2379
+        if ( ! empty($test_settings_fields)) {
2380 2380
             echo $test_settings_fields;
2381 2381
             $test_settings_html = '<input type="submit" class="button-primary mtp-test-button alignright" ';
2382 2382
             $test_settings_html .= 'name="test_button" value="';
@@ -2423,7 +2423,7 @@  discard block
 block discarded – undo
2423 2423
         );
2424 2424
 
2425 2425
         return EEH_Template::display_template(
2426
-            EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
2426
+            EE_MSG_TEMPLATE_PATH.'shortcode_selector_skeleton.template.php',
2427 2427
             $template_args,
2428 2428
             true
2429 2429
         );
@@ -2448,7 +2448,7 @@  discard block
 block discarded – undo
2448 2448
         // $messenger = $this->_message_template_group->messenger_obj();
2449 2449
         // now let's set the content depending on the status of the shortcodes array
2450 2450
         if (empty($shortcodes)) {
2451
-            $content = '<p>' . esc_html__('There are no valid shortcodes available', 'event_espresso') . '</p>';
2451
+            $content = '<p>'.esc_html__('There are no valid shortcodes available', 'event_espresso').'</p>';
2452 2452
             echo $content;
2453 2453
         } else {
2454 2454
             // $alt = 0;
@@ -2486,7 +2486,7 @@  discard block
 block discarded – undo
2486 2486
     {
2487 2487
 
2488 2488
         // no need to run this if the property is already set
2489
-        if (! empty($this->_shortcodes)) {
2489
+        if ( ! empty($this->_shortcodes)) {
2490 2490
             return;
2491 2491
         }
2492 2492
 
@@ -2540,7 +2540,7 @@  discard block
 block discarded – undo
2540 2540
     protected function _set_message_template_group()
2541 2541
     {
2542 2542
 
2543
-        if (! empty($this->_message_template_group)) {
2543
+        if ( ! empty($this->_message_template_group)) {
2544 2544
             return;
2545 2545
         } //get out if this is already set.
2546 2546
 
@@ -2587,7 +2587,7 @@  discard block
 block discarded – undo
2587 2587
                     <?php
2588 2588
                 }
2589 2589
                 // setup nonce_url
2590
-                wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
2590
+                wp_nonce_field($args['action'].'_nonce', $args['action'].'_nonce', false);
2591 2591
                 ?>
2592 2592
                 <select name="context">
2593 2593
                     <?php
@@ -2597,7 +2597,7 @@  discard block
 block discarded – undo
2597 2597
                             $checked = ($context === $args['context']) ? 'selected="selected"' : '';
2598 2598
                             ?>
2599 2599
                             <option value="<?php echo $context; ?>" <?php echo $checked; ?>>
2600
-                                <?php echo $context_details[ $context ]['label']; ?>
2600
+                                <?php echo $context_details[$context]['label']; ?>
2601 2601
                             </option>
2602 2602
                         <?php endforeach;
2603 2603
                     endif; ?>
@@ -2627,22 +2627,22 @@  discard block
 block discarded – undo
2627 2627
      */
2628 2628
     protected function _set_message_template_column_values($index)
2629 2629
     {
2630
-        if (is_array($this->_req_data['MTP_template_fields'][ $index ]['content'])) {
2631
-            foreach ($this->_req_data['MTP_template_fields'][ $index ]['content'] as $field => $value) {
2632
-                $this->_req_data['MTP_template_fields'][ $index ]['content'][ $field ] = $value;
2630
+        if (is_array($this->_req_data['MTP_template_fields'][$index]['content'])) {
2631
+            foreach ($this->_req_data['MTP_template_fields'][$index]['content'] as $field => $value) {
2632
+                $this->_req_data['MTP_template_fields'][$index]['content'][$field] = $value;
2633 2633
             }
2634 2634
         }
2635 2635
 
2636 2636
 
2637 2637
         $set_column_values = array(
2638
-            'MTP_ID'             => absint($this->_req_data['MTP_template_fields'][ $index ]['MTP_ID']),
2638
+            'MTP_ID'             => absint($this->_req_data['MTP_template_fields'][$index]['MTP_ID']),
2639 2639
             'GRP_ID'             => absint($this->_req_data['GRP_ID']),
2640 2640
             'MTP_user_id'        => absint($this->_req_data['MTP_user_id']),
2641 2641
             'MTP_messenger'      => strtolower($this->_req_data['MTP_messenger']),
2642 2642
             'MTP_message_type'   => strtolower($this->_req_data['MTP_message_type']),
2643
-            'MTP_template_field' => strtolower($this->_req_data['MTP_template_fields'][ $index ]['name']),
2643
+            'MTP_template_field' => strtolower($this->_req_data['MTP_template_fields'][$index]['name']),
2644 2644
             'MTP_context'        => strtolower($this->_req_data['MTP_context']),
2645
-            'MTP_content'        => $this->_req_data['MTP_template_fields'][ $index ]['content'],
2645
+            'MTP_content'        => $this->_req_data['MTP_template_fields'][$index]['content'],
2646 2646
             'MTP_is_global'      => isset($this->_req_data['MTP_is_global'])
2647 2647
                 ? absint($this->_req_data['MTP_is_global'])
2648 2648
                 : 0,
@@ -2689,7 +2689,7 @@  discard block
 block discarded – undo
2689 2689
         $context = ucwords(str_replace('_', ' ', $context_slug));
2690 2690
 
2691 2691
         $item_desc = $messenger_label && $message_type_label
2692
-            ? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' '
2692
+            ? $messenger_label.' '.$message_type_label.' '.$context.' '
2693 2693
             : '';
2694 2694
         $item_desc .= 'Message Template';
2695 2695
         $query_args = array();
@@ -2720,7 +2720,7 @@  discard block
 block discarded – undo
2720 2720
 
2721 2721
 
2722 2722
             // run update for each template field in displayed context
2723
-            if (! isset($this->_req_data['MTP_template_fields']) && empty($this->_req_data['MTP_template_fields'])) {
2723
+            if ( ! isset($this->_req_data['MTP_template_fields']) && empty($this->_req_data['MTP_template_fields'])) {
2724 2724
                 EE_Error::add_error(
2725 2725
                     esc_html__(
2726 2726
                         'There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
@@ -2782,10 +2782,10 @@  discard block
 block discarded – undo
2782 2782
                         $set_column_values = $this->_set_message_template_column_values($template_field);
2783 2783
 
2784 2784
                         $where_cols_n_values = array(
2785
-                            'MTP_ID' => $this->_req_data['MTP_template_fields'][ $template_field ]['MTP_ID'],
2785
+                            'MTP_ID' => $this->_req_data['MTP_template_fields'][$template_field]['MTP_ID'],
2786 2786
                         );
2787 2787
                         // if they aren't allowed to use all JS, restrict them to just posty-y tags
2788
-                        if (! current_user_can('unfiltered_html')) {
2788
+                        if ( ! current_user_can('unfiltered_html')) {
2789 2789
                             if (is_array($set_column_values['MTP_content'])) {
2790 2790
                                 foreach ($set_column_values['MTP_content'] as $key => $value) {
2791 2791
                                     // remove slashes so wp_kses works properly (its wp_kses_stripslashes() function
@@ -2793,7 +2793,7 @@  discard block
 block discarded – undo
2793 2793
                                     // appear invalid.) But currently the models expect slashed data, so after wp_kses
2794 2794
                                     // runs we need to re-slash the data. Sheesh. See
2795 2795
                                     // https://events.codebasehq.com/projects/event-espresso/tickets/11211#update-47321587
2796
-                                    $set_column_values['MTP_content'][ $key ] = addslashes(
2796
+                                    $set_column_values['MTP_content'][$key] = addslashes(
2797 2797
                                         wp_kses(
2798 2798
                                             stripslashes($value),
2799 2799
                                             wp_kses_allowed_html('post')
@@ -2829,14 +2829,14 @@  discard block
 block discarded – undo
2829 2829
                             }
2830 2830
                         } else {
2831 2831
                             // only do this logic if we don't have a MTP_ID for this field
2832
-                            if (empty($this->_req_data['MTP_template_fields'][ $template_field ]['MTP_ID'])) {
2832
+                            if (empty($this->_req_data['MTP_template_fields'][$template_field]['MTP_ID'])) {
2833 2833
                                 // this has already been through the template field validator and sanitized, so it will be
2834 2834
                                 // safe to insert this field.  Why insert?  This typically happens when we introduce a new
2835 2835
                                 // message template field in a messenger/message type and existing users don't have the
2836 2836
                                 // default setup for it.
2837 2837
                                 // @link https://events.codebasehq.com/projects/event-espresso/tickets/9465
2838 2838
                                 $updated = $MTP->insert($message_template_fields);
2839
-                                if (! $updated || is_wp_error($updated)) {
2839
+                                if ( ! $updated || is_wp_error($updated)) {
2840 2840
                                     EE_Error::add_error(
2841 2841
                                         sprintf(
2842 2842
                                             esc_html__('%s field could not be updated.', 'event_espresso'),
@@ -3063,7 +3063,7 @@  discard block
 block discarded – undo
3063 3063
         // incoming GRP_IDs
3064 3064
         if ($all) {
3065 3065
             // Checkboxes
3066
-            if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
3066
+            if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
3067 3067
                 // if array has more than one element then success message should be plural.
3068 3068
                 // todo: what about nonce?
3069 3069
                 $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
@@ -3071,16 +3071,16 @@  discard block
 block discarded – undo
3071 3071
                 // cycle through checkboxes
3072 3072
                 while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
3073 3073
                     $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
3074
-                    if (! $trashed_or_restored) {
3074
+                    if ( ! $trashed_or_restored) {
3075 3075
                         $success = 0;
3076 3076
                     }
3077 3077
                 }
3078 3078
             } else {
3079 3079
                 // grab single GRP_ID and handle
3080 3080
                 $GRP_ID = isset($this->_req_data['id']) ? absint($this->_req_data['id']) : 0;
3081
-                if (! empty($GRP_ID)) {
3081
+                if ( ! empty($GRP_ID)) {
3082 3082
                     $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
3083
-                    if (! $trashed_or_restored) {
3083
+                    if ( ! $trashed_or_restored) {
3084 3084
                         $success = 0;
3085 3085
                     }
3086 3086
                 } else {
@@ -3128,7 +3128,7 @@  discard block
 block discarded – undo
3128 3128
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
3129 3129
 
3130 3130
         // checkboxes
3131
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
3131
+        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
3132 3132
             // if array has more than one element then success message should be plural
3133 3133
             $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
3134 3134
 
@@ -3235,7 +3235,7 @@  discard block
 block discarded – undo
3235 3235
     protected function _set_m_mt_settings()
3236 3236
     {
3237 3237
         // first if this is already set then lets get out no need to regenerate data.
3238
-        if (! empty($this->_m_mt_settings)) {
3238
+        if ( ! empty($this->_m_mt_settings)) {
3239 3239
             return;
3240 3240
         }
3241 3241
 
@@ -3249,7 +3249,7 @@  discard block
 block discarded – undo
3249 3249
         // assemble the array for the _tab_text_links helper
3250 3250
 
3251 3251
         foreach ($messengers as $messenger) {
3252
-            $this->_m_mt_settings['messenger_tabs'][ $messenger->name ] = array(
3252
+            $this->_m_mt_settings['messenger_tabs'][$messenger->name] = array(
3253 3253
                 'label' => ucwords($messenger->label['singular']),
3254 3254
                 'class' => $this->_message_resource_manager->is_messenger_active($messenger->name)
3255 3255
                     ? 'messenger-active'
@@ -3266,7 +3266,7 @@  discard block
 block discarded – undo
3266 3266
             foreach ($message_types as $message_type) {
3267 3267
                 // first we need to verify that this message type is valid with this messenger. Cause if it isn't then
3268 3268
                 // it shouldn't show in either the inactive OR active metabox.
3269
-                if (! in_array($message_type->name, $message_types_for_messenger, true)) {
3269
+                if ( ! in_array($message_type->name, $message_types_for_messenger, true)) {
3270 3270
                     continue;
3271 3271
                 }
3272 3272
 
@@ -3277,12 +3277,12 @@  discard block
 block discarded – undo
3277 3277
                     ? 'active'
3278 3278
                     : 'inactive';
3279 3279
 
3280
-                $this->_m_mt_settings['message_type_tabs'][ $messenger->name ][ $a_or_i ][ $message_type->name ] = array(
3280
+                $this->_m_mt_settings['message_type_tabs'][$messenger->name][$a_or_i][$message_type->name] = array(
3281 3281
                     'label'    => ucwords($message_type->label['singular']),
3282
-                    'class'    => 'message-type-' . $a_or_i,
3283
-                    'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
3284
-                    'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
3285
-                    'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
3282
+                    'class'    => 'message-type-'.$a_or_i,
3283
+                    'slug_id'  => $message_type->name.'-messagetype-'.$messenger->name,
3284
+                    'mt_nonce' => wp_create_nonce($message_type->name.'_nonce'),
3285
+                    'href'     => 'espresso_'.$message_type->name.'_message_type_settings',
3286 3286
                     'title'    => $a_or_i === 'active'
3287 3287
                         ? esc_html__('Drag this message type to the Inactive window to deactivate', 'event_espresso')
3288 3288
                         : esc_html__('Drag this message type to the messenger to activate', 'event_espresso'),
@@ -3313,25 +3313,25 @@  discard block
 block discarded – undo
3313 3313
         $fields = $message_type->get_admin_settings_fields();
3314 3314
         $settings_template_args['template_form_fields'] = '';
3315 3315
 
3316
-        if (! empty($fields) && $active) {
3316
+        if ( ! empty($fields) && $active) {
3317 3317
             $existing_settings = $message_type->get_existing_admin_settings($messenger->name);
3318 3318
             foreach ($fields as $fldname => $fldprops) {
3319
-                $field_id = $messenger->name . '-' . $message_type->name . '-' . $fldname;
3320
-                $template_form_field[ $field_id ] = array(
3321
-                    'name'       => 'message_type_settings[' . $fldname . ']',
3319
+                $field_id = $messenger->name.'-'.$message_type->name.'-'.$fldname;
3320
+                $template_form_field[$field_id] = array(
3321
+                    'name'       => 'message_type_settings['.$fldname.']',
3322 3322
                     'label'      => $fldprops['label'],
3323 3323
                     'input'      => $fldprops['field_type'],
3324 3324
                     'type'       => $fldprops['value_type'],
3325 3325
                     'required'   => $fldprops['required'],
3326 3326
                     'validation' => $fldprops['validation'],
3327
-                    'value'      => isset($existing_settings[ $fldname ])
3328
-                        ? $existing_settings[ $fldname ]
3327
+                    'value'      => isset($existing_settings[$fldname])
3328
+                        ? $existing_settings[$fldname]
3329 3329
                         : $fldprops['default'],
3330 3330
                     'options'    => isset($fldprops['options'])
3331 3331
                         ? $fldprops['options']
3332 3332
                         : array(),
3333
-                    'default'    => isset($existing_settings[ $fldname ])
3334
-                        ? $existing_settings[ $fldname ]
3333
+                    'default'    => isset($existing_settings[$fldname])
3334
+                        ? $existing_settings[$fldname]
3335 3335
                         : $fldprops['default'],
3336 3336
                     'css_class'  => 'no-drag',
3337 3337
                     'format'     => $fldprops['format'],
@@ -3374,7 +3374,7 @@  discard block
 block discarded – undo
3374 3374
             : '';
3375 3375
 
3376 3376
 
3377
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
3377
+        $template = EE_MSG_TEMPLATE_PATH.'ee_msg_mt_settings_content.template.php';
3378 3378
         $content = EEH_Template::display_template($template, $settings_template_args, true);
3379 3379
 
3380 3380
         return $content;
@@ -3405,20 +3405,20 @@  discard block
 block discarded – undo
3405 3405
                 // messenger meta boxes
3406 3406
                 $active = $selected_messenger === $messenger;
3407 3407
                 $active_mt_tabs = isset(
3408
-                    $this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
3408
+                    $this->_m_mt_settings['message_type_tabs'][$messenger]['active']
3409 3409
                 )
3410
-                    ? $this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
3410
+                    ? $this->_m_mt_settings['message_type_tabs'][$messenger]['active']
3411 3411
                     : '';
3412
-                $m_boxes[ $messenger . '_a_box' ] = sprintf(
3412
+                $m_boxes[$messenger.'_a_box'] = sprintf(
3413 3413
                     esc_html__('%s Settings', 'event_espresso'),
3414 3414
                     $tab_array['label']
3415 3415
                 );
3416
-                $m_template_args[ $messenger . '_a_box' ] = array(
3416
+                $m_template_args[$messenger.'_a_box'] = array(
3417 3417
                     'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
3418 3418
                     'inactive_message_types' => isset(
3419
-                        $this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
3419
+                        $this->_m_mt_settings['message_type_tabs'][$messenger]['inactive']
3420 3420
                     )
3421
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
3421
+                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
3422 3422
                         : '',
3423 3423
                     'content'                => $this->_get_messenger_box_content($tab_array['obj']),
3424 3424
                     'hidden'                 => $active ? '' : ' hidden',
@@ -3429,13 +3429,13 @@  discard block
 block discarded – undo
3429 3429
                 // message type meta boxes
3430 3430
                 // (which is really just the inactive container for each messenger
3431 3431
                 // showing inactive message types for that messenger)
3432
-                $mt_boxes[ $messenger . '_i_box' ] = esc_html__('Inactive Message Types', 'event_espresso');
3433
-                $mt_template_args[ $messenger . '_i_box' ] = array(
3432
+                $mt_boxes[$messenger.'_i_box'] = esc_html__('Inactive Message Types', 'event_espresso');
3433
+                $mt_template_args[$messenger.'_i_box'] = array(
3434 3434
                     'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
3435 3435
                     'inactive_message_types' => isset(
3436
-                        $this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
3436
+                        $this->_m_mt_settings['message_type_tabs'][$messenger]['inactive']
3437 3437
                     )
3438
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
3438
+                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
3439 3439
                         : '',
3440 3440
                     'hidden'                 => $active ? '' : ' hidden',
3441 3441
                     'hide_on_message'        => $hide_on_message,
@@ -3448,14 +3448,14 @@  discard block
 block discarded – undo
3448 3448
 
3449 3449
 
3450 3450
         // register messenger metaboxes
3451
-        $m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
3451
+        $m_template_path = EE_MSG_TEMPLATE_PATH.'ee_msg_details_messenger_mt_meta_box.template.php';
3452 3452
         foreach ($m_boxes as $box => $label) {
3453
-            $callback_args = array('template_path' => $m_template_path, 'template_args' => $m_template_args[ $box ]);
3453
+            $callback_args = array('template_path' => $m_template_path, 'template_args' => $m_template_args[$box]);
3454 3454
             $msgr = str_replace('_a_box', '', $box);
3455 3455
             add_meta_box(
3456
-                'espresso_' . $msgr . '_settings',
3456
+                'espresso_'.$msgr.'_settings',
3457 3457
                 $label,
3458
-                function ($post, $metabox) {
3458
+                function($post, $metabox) {
3459 3459
                     echo EEH_Template::display_template(
3460 3460
                         $metabox["args"]["template_path"],
3461 3461
                         $metabox["args"]["template_args"],
@@ -3470,17 +3470,17 @@  discard block
 block discarded – undo
3470 3470
         }
3471 3471
 
3472 3472
         // register message type metaboxes
3473
-        $mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
3473
+        $mt_template_path = EE_MSG_TEMPLATE_PATH.'ee_msg_details_messenger_meta_box.template.php';
3474 3474
         foreach ($mt_boxes as $box => $label) {
3475 3475
             $callback_args = array(
3476 3476
                 'template_path' => $mt_template_path,
3477
-                'template_args' => $mt_template_args[ $box ],
3477
+                'template_args' => $mt_template_args[$box],
3478 3478
             );
3479 3479
             $mt = str_replace('_i_box', '', $box);
3480 3480
             add_meta_box(
3481
-                'espresso_' . $mt . '_inactive_mts',
3481
+                'espresso_'.$mt.'_inactive_mts',
3482 3482
                 $label,
3483
-                function ($post, $metabox) {
3483
+                function($post, $metabox) {
3484 3484
                     echo EEH_Template::display_template(
3485 3485
                         $metabox["args"]["template_path"],
3486 3486
                         $metabox["args"]["template_args"],
@@ -3626,7 +3626,7 @@  discard block
 block discarded – undo
3626 3626
             if ($form->is_valid()) {
3627 3627
                 $valid_data = $form->valid_data();
3628 3628
                 foreach ($valid_data as $property => $value) {
3629
-                    $setter = 'set_' . $property;
3629
+                    $setter = 'set_'.$property;
3630 3630
                     if (method_exists($network_config, $setter)) {
3631 3631
                         $network_config->{$setter}($value);
3632 3632
                     } elseif (property_exists($network_config, $property)
@@ -3660,7 +3660,7 @@  discard block
 block discarded – undo
3660 3660
     protected function _get_mt_tabs($tab_array)
3661 3661
     {
3662 3662
         $tab_array = (array) $tab_array;
3663
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
3663
+        $template = EE_MSG_TEMPLATE_PATH.'ee_msg_details_mt_settings_tab_item.template.php';
3664 3664
         $tabs = '';
3665 3665
 
3666 3666
         foreach ($tab_array as $tab) {
@@ -3688,20 +3688,20 @@  discard block
 block discarded – undo
3688 3688
         $settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
3689 3689
 
3690 3690
 
3691
-        if (! empty($fields)) {
3691
+        if ( ! empty($fields)) {
3692 3692
             $existing_settings = $messenger->get_existing_admin_settings();
3693 3693
 
3694 3694
             foreach ($fields as $fldname => $fldprops) {
3695
-                $field_id = $messenger->name . '-' . $fldname;
3696
-                $template_form_field[ $field_id ] = array(
3697
-                    'name'       => 'messenger_settings[' . $field_id . ']',
3695
+                $field_id = $messenger->name.'-'.$fldname;
3696
+                $template_form_field[$field_id] = array(
3697
+                    'name'       => 'messenger_settings['.$field_id.']',
3698 3698
                     'label'      => $fldprops['label'],
3699 3699
                     'input'      => $fldprops['field_type'],
3700 3700
                     'type'       => $fldprops['value_type'],
3701 3701
                     'required'   => $fldprops['required'],
3702 3702
                     'validation' => $fldprops['validation'],
3703
-                    'value'      => isset($existing_settings[ $field_id ])
3704
-                        ? $existing_settings[ $field_id ]
3703
+                    'value'      => isset($existing_settings[$field_id])
3704
+                        ? $existing_settings[$field_id]
3705 3705
                         : $fldprops['default'],
3706 3706
                     'css_class'  => '',
3707 3707
                     'format'     => $fldprops['format'],
@@ -3727,9 +3727,9 @@  discard block
 block discarded – undo
3727 3727
         );
3728 3728
 
3729 3729
         // make sure any active message types that are existing are included in the hidden fields
3730
-        if (isset($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'])) {
3731
-            foreach ($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'] as $mt => $values) {
3732
-                $settings_template_args['hidden_fields'][ 'messenger_settings[message_types][' . $mt . ']' ] = array(
3730
+        if (isset($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'])) {
3731
+            foreach ($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'] as $mt => $values) {
3732
+                $settings_template_args['hidden_fields']['messenger_settings[message_types]['.$mt.']'] = array(
3733 3733
                     'type'  => 'hidden',
3734 3734
                     'value' => $mt,
3735 3735
                 );
@@ -3758,9 +3758,9 @@  discard block
 block discarded – undo
3758 3758
 
3759 3759
 
3760 3760
         $settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
3761
-        $settings_template_args['nonce'] = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
3761
+        $settings_template_args['nonce'] = wp_create_nonce('activate_'.$messenger->name.'_toggle_nonce');
3762 3762
         $settings_template_args['on_off_status'] = $active ? true : false;
3763
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
3763
+        $template = EE_MSG_TEMPLATE_PATH.'ee_msg_m_settings_content.template.php';
3764 3764
         $content = EEH_Template::display_template(
3765 3765
             $template,
3766 3766
             $settings_template_args,
@@ -3786,7 +3786,7 @@  discard block
 block discarded – undo
3786 3786
         $success = true;
3787 3787
         $this->_prep_default_response_for_messenger_or_message_type_toggle();
3788 3788
         // let's check that we have required data
3789
-        if (! isset($this->_req_data['messenger'])) {
3789
+        if ( ! isset($this->_req_data['messenger'])) {
3790 3790
             EE_Error::add_error(
3791 3791
                 esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
3792 3792
                 __FILE__,
@@ -3800,12 +3800,12 @@  discard block
 block discarded – undo
3800 3800
         $nonce = isset($this->_req_data['activate_nonce'])
3801 3801
             ? sanitize_text_field($this->_req_data['activate_nonce'])
3802 3802
             : '';
3803
-        $nonce_ref = 'activate_' . $this->_req_data['messenger'] . '_toggle_nonce';
3803
+        $nonce_ref = 'activate_'.$this->_req_data['messenger'].'_toggle_nonce';
3804 3804
 
3805 3805
         $this->_verify_nonce($nonce, $nonce_ref);
3806 3806
 
3807 3807
 
3808
-        if (! isset($this->_req_data['status'])) {
3808
+        if ( ! isset($this->_req_data['status'])) {
3809 3809
             EE_Error::add_error(
3810 3810
                 esc_html__(
3811 3811
                     'Messenger status needed to know whether activation or deactivation is happening. No status is given',
@@ -3864,7 +3864,7 @@  discard block
 block discarded – undo
3864 3864
         $this->_prep_default_response_for_messenger_or_message_type_toggle();
3865 3865
 
3866 3866
         // let's make sure we have the necessary data
3867
-        if (! isset($this->_req_data['message_type'])) {
3867
+        if ( ! isset($this->_req_data['message_type'])) {
3868 3868
             EE_Error::add_error(
3869 3869
                 esc_html__('Message Type name needed to toggle activation. None given', 'event_espresso'),
3870 3870
                 __FILE__,
@@ -3874,7 +3874,7 @@  discard block
 block discarded – undo
3874 3874
             $success = false;
3875 3875
         }
3876 3876
 
3877
-        if (! isset($this->_req_data['messenger'])) {
3877
+        if ( ! isset($this->_req_data['messenger'])) {
3878 3878
             EE_Error::add_error(
3879 3879
                 esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
3880 3880
                 __FILE__,
@@ -3884,7 +3884,7 @@  discard block
 block discarded – undo
3884 3884
             $success = false;
3885 3885
         }
3886 3886
 
3887
-        if (! isset($this->_req_data['status'])) {
3887
+        if ( ! isset($this->_req_data['status'])) {
3888 3888
             EE_Error::add_error(
3889 3889
                 esc_html__(
3890 3890
                     'Messenger status needed to know whether activation or deactivation is happening. No status is given',
@@ -3917,7 +3917,7 @@  discard block
 block discarded – undo
3917 3917
 
3918 3918
         // do a nonce check here since we're not arriving via a normal route
3919 3919
         $nonce = isset($this->_req_data['mt_nonce']) ? sanitize_text_field($this->_req_data['mt_nonce']) : '';
3920
-        $nonce_ref = $this->_req_data['message_type'] . '_nonce';
3920
+        $nonce_ref = $this->_req_data['message_type'].'_nonce';
3921 3921
 
3922 3922
         $this->_verify_nonce($nonce, $nonce_ref);
3923 3923
 
@@ -4104,7 +4104,7 @@  discard block
 block discarded – undo
4104 4104
         EE_Message_Type $message_type = null
4105 4105
     ) {
4106 4106
         // if $messenger isn't a valid messenger object then get out.
4107
-        if (! $messenger instanceof EE_Messenger) {
4107
+        if ( ! $messenger instanceof EE_Messenger) {
4108 4108
             EE_Error::add_error(
4109 4109
                 esc_html__('The messenger being activated is not a valid messenger', 'event_espresso'),
4110 4110
                 __FILE__,
@@ -4159,7 +4159,7 @@  discard block
 block discarded – undo
4159 4159
             // message types after the activation process.  However its possible some messengers don't HAVE any default_message_types
4160 4160
             // in which case we just give a success message for the messenger being successfully activated.
4161 4161
         } else {
4162
-            if (! $messenger->get_default_message_types()) {
4162
+            if ( ! $messenger->get_default_message_types()) {
4163 4163
                 // messenger doesn't have any default message types so still a success.
4164 4164
                 EE_Error::add_success(
4165 4165
                     sprintf(
@@ -4215,7 +4215,7 @@  discard block
 block discarded – undo
4215 4215
         EE_Error::overwrite_success();
4216 4216
 
4217 4217
         // if $messenger isn't a valid messenger object then get out.
4218
-        if (! $messenger instanceof EE_Messenger) {
4218
+        if ( ! $messenger instanceof EE_Messenger) {
4219 4219
             EE_Error::add_error(
4220 4220
                 esc_html__('The messenger being deactivated is not a valid messenger', 'event_espresso'),
4221 4221
                 __FILE__,
@@ -4277,7 +4277,7 @@  discard block
 block discarded – undo
4277 4277
      */
4278 4278
     public function update_mt_form()
4279 4279
     {
4280
-        if (! isset($this->_req_data['messenger']) || ! isset($this->_req_data['message_type'])) {
4280
+        if ( ! isset($this->_req_data['messenger']) || ! isset($this->_req_data['message_type'])) {
4281 4281
             EE_Error::add_error(
4282 4282
                 esc_html__('Require message type or messenger to send an updated form', 'event_espresso'),
4283 4283
                 __FILE__,
@@ -4289,7 +4289,7 @@  discard block
 block discarded – undo
4289 4289
 
4290 4290
         $message_types = $this->get_installed_message_types();
4291 4291
 
4292
-        $message_type = $message_types[ $this->_req_data['message_type'] ];
4292
+        $message_type = $message_types[$this->_req_data['message_type']];
4293 4293
         $messenger = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
4294 4294
 
4295 4295
         $content = $this->_message_type_settings_content(
@@ -4309,7 +4309,7 @@  discard block
 block discarded – undo
4309 4309
      */
4310 4310
     public function save_settings()
4311 4311
     {
4312
-        if (! isset($this->_req_data['type'])) {
4312
+        if ( ! isset($this->_req_data['type'])) {
4313 4313
             EE_Error::add_error(
4314 4314
                 esc_html__(
4315 4315
                     'Cannot save settings because type is unknown (messenger settings or messsage type settings?)',
@@ -4338,7 +4338,7 @@  discard block
 block discarded – undo
4338 4338
                         unset($settings['message_types']);
4339 4339
                         break;
4340 4340
                     default:
4341
-                        $settings[ $key ] = $value;
4341
+                        $settings[$key] = $value;
4342 4342
                         break;
4343 4343
                 }
4344 4344
             }
@@ -4357,7 +4357,7 @@  discard block
 block discarded – undo
4357 4357
                         unset($settings['message_type']);
4358 4358
                         break;
4359 4359
                     default:
4360
-                        $settings[ $key ] = $value;
4360
+                        $settings[$key] = $value;
4361 4361
                         break;
4362 4362
                 }
4363 4363
             }
@@ -4518,7 +4518,7 @@  discard block
 block discarded – undo
4518 4518
      */
4519 4519
     protected function _get_msg_ids_from_request()
4520 4520
     {
4521
-        if (! isset($this->_req_data['MSG_ID'])) {
4521
+        if ( ! isset($this->_req_data['MSG_ID'])) {
4522 4522
             return array();
4523 4523
         }
4524 4524
 
Please login to merge, or discard this patch.