PluginProbe
Formidable Forms – WordPress Form Builder for Contact Forms, Calculators, Quizzes & More / 5.0
Formidable Forms – WordPress Form Builder for Contact Forms, Calculators, Quizzes & More v5.0
6.35 6.34 6.33.1 6.33 6.32.1 6.32 6.31 6.25 6.25.1 6.26 6.26.1 6.27 6.28 6.29 6.3 6.3.1 6.3.2 6.30 6.4 6.4.1 6.4.2 6.5 6.5.1 6.5.2 6.5.3 All 141 releases
← All changes | classes/models/FrmInbox.php +61 -378 6.275.0 View file →
@@ -9,35 +9,19 @@
9 9 class FrmInbox extends FrmFormApi {
10 10
11 11 protected $cache_key;
12 12
13 - /**
14 - * @var string
15 - */
16 13 private $option = 'frm_inbox';
17 14
18 - /**
19 - * @var array|false
20 - */
21 - private static $messages = false;
15 + private $messages = false;
22 16
23 - /**
24 - * @var array
25 - */
26 - private static $banner_messages;
27 -
28 - public function __construct() {
17 + public function __construct( $for_parent = null ) {
29 18 $this->set_cache_key();
30 -
31 - if ( false === self::$messages ) {
32 - $this->set_messages();
33 - }
19 + $this->set_messages();
34 20 }
35 21
36 22 /**
37 23 * @since 4.05
38 - *
39 - * @return void
40 24 */
41 25 protected function set_cache_key() {
42 26 $this->cache_key = 'frm_inbox_cache';
43 27 }
@@ -43,10 +27,8 @@
43 27 }
44 28
45 29 /**
46 30 * @since 4.05
47 - *
48 - * @return string
49 31 */
50 32 protected function api_url() {
51 33 return 'https://formidableforms.com/wp-json/inbox/v1/message/';
52 34 }
@@ -52,33 +34,24 @@
52 34 }
53 35
54 36 /**
55 37 * @since 4.05
56 - *
57 - * @param array|false $filter
58 - *
59 - * @return array
60 38 */
61 39 public function get_messages( $filter = false ) {
62 - $messages = self::$messages;
63 -
40 + $messages = $this->messages;
64 41 if ( $filter === 'filter' ) {
65 42 $this->filter_messages( $messages );
66 43 }
67 -
68 44 return $messages;
69 45 }
70 46
71 47 /**
72 48 * @since 4.05
73 - *
74 - * @return void
75 49 */
76 50 public function set_messages() {
77 - self::$messages = get_option( $this->option );
78 -
79 - if ( ! is_array( self::$messages ) ) {
80 - self::$messages = array();
51 + $this->messages = get_option( $this->option );
52 + if ( empty( $this->messages ) ) {
53 + $this->messages = array();
81 54 }
82 55
83 56 $this->add_api_messages();
84 57
@@ -84,20 +57,17 @@
84 57
85 58 /**
86 59 * Messages are in an array.
87 60 */
88 - self::$messages = apply_filters( 'frm_inbox', self::$messages );
61 + $this->messages = apply_filters( 'frm_inbox', $this->messages );
89 62 }
90 63
91 64 /**
92 65 * @since 4.05
93 - *
94 - * @return void
95 66 */
96 67 private function add_api_messages() {
97 68 $api = $this->get_api_info();
98 -
99 - if ( ! $api ) {
69 + if ( empty( $api ) ) {
100 70 return;
101 71 }
102 72
103 73 foreach ( $api as $message ) {
@@ -106,34 +76,31 @@
106 76 }
107 77
108 78 /**
109 79 * @param array|string $message
110 - *
111 - * @return void
112 80 */
113 81 public function add_message( $message ) {
114 - if ( ! is_array( $message ) || ! isset( $message['key'] ) ) {
82 + if ( ! is_array( $message ) ) {
115 83 // if the API response is invalid, $message may not be an array.
116 - // if there are no messages from the API, it is returning a "No Entries Found" item with no key, so check for a key as well.
117 84 return;
118 85 }
119 86
120 - if ( isset( self::$messages[ $message['key'] ] ) && ! isset( $message['force'] ) ) {
87 + if ( isset( $this->messages[ $message['key'] ] ) && ! isset( $message['force'] ) ) {
121 88 // Don't replace messages unless required.
122 89 return;
123 90 }
124 91
125 - if ( ! $this->within_valid_timeframe( $message ) ) {
92 + if ( $this->is_expired( $message ) ) {
126 93 return;
127 94 }
128 95
129 - if ( isset( self::$messages[ $message['key'] ] ) ) {
96 + if ( isset( $this->messages[ $message['key'] ] ) ) {
130 97 // Move up and mark as new.
131 - unset( self::$messages[ $message['key'] ] );
98 + unset( $this->messages[ $message['key'] ] );
132 99 }
133 100
134 101 $this->fill_message( $message );
135 - self::$messages[ $message['key'] ] = $message;
102 + $this->messages[ $message['key'] ] = $message;
136 103
137 104 $this->update_list();
138 105
139 106 $this->clean_messages();
@@ -138,13 +105,8 @@
138 105
139 106 $this->clean_messages();
140 107 }
141 108
142 - /**
143 - * @param array $message
144 - *
145 - * @return void
146 - */
147 109 private function fill_message( &$message ) {
148 110 $defaults = array(
149 111 'time' => time(),
150 112 'message' => '',
@@ -151,10 +113,9 @@
151 113 'subject' => '',
152 114 'icon' => 'frm_tooltip_icon',
153 115 'cta' => '',
154 116 'expires' => false,
155 - // Use 'free', 'personal', 'business', 'elite', 'grandfathered'.
156 - 'who' => 'all',
117 + 'who' => 'all', // use 'free', 'personal', 'business', 'elite', 'grandfathered'
157 118 'type' => '',
158 119 );
159 120
160 121 $message = array_merge( $defaults, $message );
@@ -162,20 +123,16 @@
162 123 $message['created'] = $message['time'];
163 124 unset( $message['time'] );
164 125 }
165 126
166 - /**
167 - * @return void
168 - */
169 127 private function clean_messages() {
170 - $removed = false;
171 -
172 - foreach ( self::$messages as $t => $message ) {
173 - $read = ! empty( $message['read'] ) && isset( $message['read'][ get_current_user_id() ] ) && $message['read'][ get_current_user_id() ] < strtotime( '-1 month' );
174 - $dismissed = ! empty( $message['dismissed'] ) && isset( $message['dismissed'][ get_current_user_id() ] ) && $message['dismissed'][ get_current_user_id() ] < strtotime( '-1 week' ); // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
175 -
176 - if ( $read || $dismissed || ! $this->within_valid_timeframe( $message ) ) {
177 - unset( self::$messages[ $t ] );
128 + $removed = false;
129 + foreach ( $this->messages as $t => $message ) {
130 + $read = isset( $message['read'] ) && ! empty( $message['read'] ) && isset( $message['read'][ get_current_user_id() ] ) && $message['read'][ get_current_user_id() ] < strtotime( '-1 month' );
131 + $dismissed = isset( $message['dismissed'] ) && ! empty( $message['dismissed'] ) && isset( $message['dismissed'][ get_current_user_id() ] ) && $message['dismissed'][ get_current_user_id() ] < strtotime( '-1 week' );
132 + $expired = $this->is_expired( $message );
133 + if ( $read || $expired || $dismissed ) {
134 + unset( $this->messages[ $t ] );
178 135 $removed = true;
179 136 }
180 137 }
181 138
@@ -183,121 +140,69 @@
183 140 $this->update_list();
184 141 }
185 142 }
186 143
187 - /**
188 - * @param array $messages
189 - * @param string $type
190 - *
191 - * @return void
192 - */
193 - public function filter_messages( &$messages, $type = 'unread' ) {
144 + private function filter_messages( &$messages ) {
194 145 $user_id = get_current_user_id();
195 -
196 146 foreach ( $messages as $k => $message ) {
197 147 $dismissed = isset( $message['dismissed'] ) && isset( $message['dismissed'][ $user_id ] );
198 -
199 - if ( empty( $k ) || ! $this->within_valid_timeframe( $message ) || ( $type === 'dismissed' ) !== $dismissed ) {
148 + if ( empty( $k ) || $this->is_expired( $message ) || $dismissed ) {
200 149 unset( $messages[ $k ] );
201 150 } elseif ( ! $this->is_for_user( $message ) ) {
202 151 unset( $messages[ $k ] );
203 152 }
204 153 }
205 -
206 154 $messages = apply_filters( 'frm_filter_inbox', $messages );
207 155 }
208 156
209 - /**
210 - * Check if a message has started and is not expired.
211 - *
212 - * @since 6.25
213 - *
214 - * @param array $message
215 - *
216 - * @return bool
217 - */
218 - private function within_valid_timeframe( $message ) {
219 - return $this->has_started( $message ) && ! $this->is_expired( $message );
220 - }
221 -
222 - /**
223 - * Check if a message has actually started, so we can prevent showing something that is queued up early.
224 - *
225 - * @since 6.25
226 - *
227 - * @param array $message
228 - *
229 - * @return bool
230 - */
231 - private function has_started( $message ) {
232 - return empty( $message['starts'] ) ? true : $message['starts'] <= time();
233 - }
234 -
235 - /**
236 - * @param array $message
237 - *
238 - * @return bool
239 - */
240 157 private function is_expired( $message ) {
241 - return ! empty( $message['expires'] ) && $message['expires'] < time();
158 + return isset( $message['expires'] ) && ! empty( $message['expires'] ) && $message['expires'] < time();
242 159 }
243 160
244 161 /**
245 162 * Show different messages for different accounts.
246 - *
247 - * @param array $message
248 - *
249 - * @return bool
250 163 */
251 164 private function is_for_user( $message ) {
252 - if ( FrmApiHelper::is_for_user( $message ) ) {
165 + if ( ! isset( $message['who'] ) || $message['who'] === 'all' ) {
253 166 return true;
254 167 }
255 168
256 - $who = (array) $message['who'];
169 + return in_array( $this->get_user_type(), (array) $message['who'] );
170 + }
257 171
258 - /**
259 - * Allow for other special inbox cases in other add-ons.
260 - *
261 - * @since 6.8.1
262 - *
263 - * @param bool $is_for_user
264 - * @param array $who
265 - * @param array $message
266 - */
267 - return (bool) apply_filters( 'frm_inbox_message_is_for_user', false, $who, $message );
172 + private function get_user_type() {
173 + if ( ! FrmAppHelper::pro_is_installed() ) {
174 + return 'free';
175 + }
176 +
177 + return FrmAddonsController::license_type();
268 178 }
269 179
270 180 /**
271 181 * @param string $key
272 - *
273 - * @return void
274 182 */
275 183 public function mark_read( $key ) {
276 - if ( ! $key || ! isset( self::$messages[ $key ] ) ) {
184 + if ( ! $key || ! isset( $this->messages[ $key ] ) ) {
277 185 return;
278 186 }
279 187
280 - if ( ! isset( self::$messages[ $key ]['read'] ) ) {
281 - self::$messages[ $key ]['read'] = array();
188 + if ( ! isset( $this->messages[ $key ]['read'] ) ) {
189 + $this->messages[ $key ]['read'] = array();
282 190 }
283 - self::$messages[ $key ]['read'][ get_current_user_id() ] = time();
191 + $this->messages[ $key ]['read'][ get_current_user_id() ] = time();
284 192
285 193 $this->update_list();
286 194 }
287 195
288 196 /**
289 - * @since 4.05.02
290 - *
291 197 * @param string $key
292 198 *
293 - * @return void
199 + * @since 4.05.02
294 200 */
295 201 public function mark_unread( $key ) {
296 - $is_read = isset( self::$messages[ $key ] ) && isset( self::$messages[ $key ]['read'] ) && isset( self::$messages[ $key ]['read'][ get_current_user_id() ] );
297 -
202 + $is_read = isset( $this->messages[ $key ] ) && isset( $this->messages[ $key ]['read'] ) && isset( $this->messages[ $key ]['read'][ get_current_user_id() ] );
298 203 if ( $is_read ) {
299 - unset( self::$messages[ $key ]['read'][ get_current_user_id() ] );
204 + unset( $this->messages[ $key ]['read'][ get_current_user_id() ] );
300 205 $this->update_list();
301 206 }
302 207 }
303 208
@@ -302,10 +207,8 @@
302 207 }
303 208
304 209 /**
305 210 * @param string $key
306 - *
307 - * @return void
308 211 */
309 212 public function dismiss( $key ) {
310 213 if ( $key === 'all' ) {
311 214 $this->dismiss_all();
@@ -311,16 +214,16 @@
311 214 $this->dismiss_all();
312 215 return;
313 216 }
314 217
315 - if ( ! isset( self::$messages[ $key ] ) ) {
218 + if ( ! isset( $this->messages[ $key ] ) ) {
316 219 return;
317 220 }
318 221
319 - if ( ! isset( self::$messages[ $key ]['dismissed'] ) ) {
320 - self::$messages[ $key ]['dismissed'] = array();
222 + if ( ! isset( $this->messages[ $key ]['dismissed'] ) ) {
223 + $this->messages[ $key ]['dismissed'] = array();
321 224 }
322 - self::$messages[ $key ]['dismissed'][ get_current_user_id() ] = time();
225 + $this->messages[ $key ]['dismissed'][ get_current_user_id() ] = time();
323 226
324 227 $this->update_list();
325 228 }
326 229
@@ -325,278 +228,58 @@
325 228 }
326 229
327 230 /**
328 231 * @since 4.06
329 - *
330 - * @return void
331 232 */
332 233 private function dismiss_all() {
333 234 $user_id = get_current_user_id();
334 -
335 - foreach ( self::$messages as $key => $message ) {
235 + foreach ( $this->messages as $key => $message ) {
336 236 if ( ! isset( $message['dismissed'] ) ) {
337 - self::$messages[ $key ]['dismissed'] = array();
237 + $this->messages[ $key ]['dismissed'] = array();
338 238 }
339 239
340 240 if ( ! isset( $message['dismissed'][ $user_id ] ) ) {
341 - self::$messages[ $key ]['dismissed'][ $user_id ] = time();
241 + $this->messages[ $key ]['dismissed'][ $user_id ] = time();
342 242 }
343 243 }
344 244 $this->update_list();
345 245 }
346 246
347 - /**
348 - * @return array
349 - */
350 247 public function unread() {
351 248 $messages = $this->get_messages( 'filter' );
352 249 $user_id = get_current_user_id();
353 -
354 250 foreach ( $messages as $t => $message ) {
355 251 if ( isset( $message['read'] ) && isset( $message['read'][ $user_id ] ) ) {
356 252 unset( $messages[ $t ] );
357 253 }
358 254 }
359 -
360 255 return $messages;
361 256 }
362 257
363 - /**
364 - * @since 6.8.4 The $filtered parameter was added.
365 - *
366 - * @param bool $filtered
367 - *
368 - * @return string
369 - */
370 - public function unread_html( $filtered = true ) {
258 + public function unread_html() {
259 + $html = '';
371 260 $count = count( $this->unread() );
261 + if ( $count ) {
262 + $html = ' <span class="update-plugins frm_inbox_count"><span class="plugin-count">' . absint( $count ) . '</span></span>';
372 263
373 - if ( ! $count ) {
374 - return '';
264 + /**
265 + * @since 4.06.01
266 + */
267 + $html = apply_filters( 'frm_inbox_badge', $html );
375 268 }
376 -
377 - $html = ' <span class="update-plugins frm_inbox_count"><span class="plugin-count">' . absint( $count ) . '</span></span>';
378 -
379 - if ( ! $filtered ) {
380 - return $html;
381 - }
382 -
383 - /**
384 - * @since 4.06.01
385 - *
386 - * @param string $html
387 - */
388 - return (string) apply_filters( 'frm_inbox_badge', $html );
269 + return $html;
389 270 }
390 271
391 272 /**
392 273 * @since 4.05.02
393 - *
394 - * @param string $key
395 - *
396 - * @return void
397 274 */
398 275 public function remove( $key ) {
399 - if ( isset( self::$messages[ $key ] ) ) {
400 - unset( self::$messages[ $key ] );
276 + if ( isset( $this->messages[ $key ] ) ) {
277 + unset( $this->messages[ $key ] );
401 278 $this->update_list();
402 279 }
403 280 }
404 281
405 - /**
406 - * @return void
407 - */
408 282 private function update_list() {
409 - update_option( $this->option, self::$messages, 'no' );
410 - }
411 -
412 - /**
413 - * Show a banner message if one is available.
414 - *
415 - * @return bool True if a banner is available and shown.
416 - */
417 - public static function maybe_show_banner() {
418 - if ( empty( self::$banner_messages ) ) {
419 - return false;
420 - }
421 -
422 - $message = end( self::$banner_messages );
423 - $cta = self::get_prepared_banner_cta( $message['cta'] );
424 -
425 - require FrmAppHelper::plugin_path() . '/classes/views/inbox/banner.php';
426 - return true;
427 - }
428 -
429 - /**
430 - * Make sure that the CTA uses utm_medium=banner.
431 - *
432 - * @since 6.8.4
433 - *
434 - * @param string $cta
435 - *
436 - * @return string
437 - */
438 - private static function get_prepared_banner_cta( $cta ) {
439 - $cta = str_replace( 'button-secondary', 'button-primary', $cta );
440 - return preg_replace_callback(
441 - '/href=("|\')(.*?)("|\')/',
442 - /**
443 - * Replace a single href attribute in the CTA.
444 - *
445 - * @param array $matches The regex results for a single match.
446 - *
447 - * @return string
448 - */
449 - function ( $matches ) {
450 - $url = $matches[2];
451 - $parts = parse_url( $url );
452 -
453 - if ( '#' === $url ) {
454 - return 'href="#"';
455 - }
456 -
457 - $query = array();
458 -
459 - if ( isset( $parts['query'] ) ) {
460 - parse_str( $parts['query'], $query );
461 - }
462 -
463 - $query['utm_medium'] = 'banner';
464 - $parts['query'] = http_build_query( $query );
465 - return 'href="' . $parts['scheme'] . '://' . $parts['host'] . $parts['path'] . '?' . $parts['query'] . '"';
466 - },
467 - $cta
468 - );
469 - }
470 -
471 - /**
472 - * @return void
473 - */
474 - public static function maybe_disable_screen_options() {
475 - self::$banner_messages = self::get_banner_messages();
476 -
477 - if ( self::$banner_messages ) {
478 - // disable screen options tab when displaying banner messages because it gets in the way of the banner.
479 - add_filter( 'screen_options_show_screen', '__return_false' );
480 - }
481 - }
482 -
483 - /**
484 - * Get all message with a "banner" message key defined.
485 - *
486 - * @return array
487 - */
488 - private static function get_banner_messages() {
489 - return self::get_messages_with_key( 'banner' );
490 - }
491 -
492 - /**
493 - * Get all messages with a "slidein" message key defined.
494 - *
495 - * @since 6.8.4
496 - *
497 - * @return array
498 - */
499 - private static function get_slidein_messages() {
500 - return self::get_messages_with_key( 'slidein' );
501 - }
502 -
503 - /**
504 - * Get all messages with a $key message key defined.
505 - *
506 - * @since 6.8.4
507 - *
508 - * @param string $key The key we are checking for (ie. banner or slidein).
509 - *
510 - * @return array
511 - */
512 - private static function get_messages_with_key( $key ) {
513 - $inbox = new self();
514 - return array_filter(
515 - $inbox->get_messages( 'filter' ),
516 - function ( $message ) use ( $key ) {
517 - return ! empty( $message[ $key ] );
518 - }
519 - );
520 - }
521 -
522 - /**
523 - * Check if there is at least one slidein message.
524 - *
525 - * @since 6.8.4
526 - *
527 - * @return bool
528 - */
529 - public static function has_a_slidein_message() {
530 - return (bool) self::get_slidein_messages();
531 - }
532 -
533 - /**
534 - * Get the array used for frmGlobal.inboxSlideIn
535 - *
536 - * @since 6.8.4
537 - *
538 - * @return array|false
539 - */
540 - public static function get_inbox_slide_in_value_for_js() {
541 - $messages = self::get_slidein_messages();
542 -
543 - if ( ! $messages ) {
544 - return false;
545 - }
546 -
547 - $message = reset( $messages );
548 -
549 - /**
550 - * Extend the keys in the global JS object.
551 - * This is used in Pro to include images.
552 - *
553 - * @since 6.8.4
554 - *
555 - * @param array $keys
556 - */
557 - $keys_to_return = apply_filters(
558 - 'frm_inbox_slidein_js_vars',
559 - array( 'key', 'slidein', 'subject', 'cta' )
560 - );
561 -
562 - return array_reduce(
563 - $keys_to_return,
564 - function ( $total, $key ) use ( $message ) {
565 - $total[ $key ] = $message[ $key ] ?? '';
566 - return $total;
567 - },
568 - array()
569 - );
570 - }
571 -
572 - /**
573 - * Clear the inbox cache by deleting the associated option from the database.
574 - *
575 - * @since 6.17
576 - *
577 - * @return void
578 - */
579 - public static function clear_cache() {
580 - delete_option( 'frm_inbox' );
581 - }
582 -
583 - /**
584 - * Check inbox for an "error" type. This is displayed on the form list page if one exists.
585 - *
586 - * @since 6.19
587 - *
588 - * @return array|false
589 - */
590 - public static function check_for_error() {
591 - $inbox = new self();
592 - $messages = $inbox->get_messages( 'filter' );
593 -
594 - foreach ( $messages as $message ) {
595 - if ( is_array( $message ) && isset( $message['type'] ) && 'error' === $message['type'] ) {
596 - return $message;
597 - }
598 - }
599 -
600 - return false;
283 + update_option( $this->option, $this->messages, 'no' );
601 284 }
602 285 }