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