PluginProbe
Formidable Forms – WordPress Form Builder for Contact Forms, Calculators, Quizzes & More / 5.2.06
Formidable Forms – WordPress Form Builder for Contact Forms, Calculators, Quizzes & More v5.2.06
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 +37 -310 6.275.2.06 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 array|false $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,10 +84,8 @@
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 91 // if the API response is invalid, $message may not be an array.
@@ -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,19 +132,15 @@
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 ) ) {
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 ) {
177 143 unset( self::$messages[ $t ] );
178 144 $removed = true;
179 145 }
180 146 }
@@ -183,63 +149,23 @@
183 149 $this->update_list();
184 150 }
185 151 }
186 152
187 - /**
188 - * @param array $messages
189 - * @param string $type
190 - *
191 - * @return void
192 - */
193 - public function filter_messages( &$messages, $type = 'unread' ) {
153 + private function filter_messages( &$messages ) {
194 154 $user_id = get_current_user_id();
195 -
196 155 foreach ( $messages as $k => $message ) {
197 156 $dismissed = isset( $message['dismissed'] ) && isset( $message['dismissed'][ $user_id ] );
198 -
199 - if ( empty( $k ) || ! $this->within_valid_timeframe( $message ) || ( $type === 'dismissed' ) !== $dismissed ) {
157 + if ( empty( $k ) || $this->is_expired( $message ) || $dismissed ) {
200 158 unset( $messages[ $k ] );
201 159 } elseif ( ! $this->is_for_user( $message ) ) {
202 160 unset( $messages[ $k ] );
203 161 }
204 162 }
205 -
206 163 $messages = apply_filters( 'frm_filter_inbox', $messages );
207 164 }
208 165
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 166 private function is_expired( $message ) {
241 - return ! empty( $message['expires'] ) && $message['expires'] < time();
167 + return isset( $message['expires'] ) && ! empty( $message['expires'] ) && $message['expires'] < time();
242 168 }
243 169
244 170 /**
245 171 * Show different messages for different accounts.
@@ -244,34 +170,31 @@
244 170 /**
245 171 * Show different messages for different accounts.
246 172 *
247 173 * @param array $message
248 - *
249 174 * @return bool
250 175 */
251 176 private function is_for_user( $message ) {
252 - if ( FrmApiHelper::is_for_user( $message ) ) {
177 + if ( ! isset( $message['who'] ) || $message['who'] === 'all' ) {
253 178 return true;
254 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 + }
255 186
256 - $who = (array) $message['who'];
187 + private function get_user_type() {
188 + if ( ! FrmAppHelper::pro_is_installed() ) {
189 + return 'free';
190 + }
257 191
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 );
192 + return FrmAddonsController::license_type();
268 193 }
269 194
270 195 /**
271 196 * @param string $key
272 - *
273 - * @return void
274 197 */
275 198 public function mark_read( $key ) {
276 199 if ( ! $key || ! isset( self::$messages[ $key ] ) ) {
277 200 return;
@@ -285,17 +208,14 @@
285 208 $this->update_list();
286 209 }
287 210
288 211 /**
289 - * @since 4.05.02
290 - *
291 212 * @param string $key
292 213 *
293 - * @return void
214 + * @since 4.05.02
294 215 */
295 216 public function mark_unread( $key ) {
296 217 $is_read = isset( self::$messages[ $key ] ) && isset( self::$messages[ $key ]['read'] ) && isset( self::$messages[ $key ]['read'][ get_current_user_id() ] );
297 -
298 218 if ( $is_read ) {
299 219 unset( self::$messages[ $key ]['read'][ get_current_user_id() ] );
300 220 $this->update_list();
301 221 }
@@ -302,10 +222,8 @@
302 222 }
303 223
304 224 /**
305 225 * @param string $key
306 - *
307 - * @return void
308 226 */
309 227 public function dismiss( $key ) {
310 228 if ( $key === 'all' ) {
311 229 $this->dismiss_all();
@@ -325,14 +243,11 @@
325 243 }
326 244
327 245 /**
328 246 * @since 4.06
329 - *
330 - * @return void
331 247 */
332 248 private function dismiss_all() {
333 249 $user_id = get_current_user_id();
334 -
335 250 foreach ( self::$messages as $key => $message ) {
336 251 if ( ! isset( $message['dismissed'] ) ) {
337 252 self::$messages[ $key ]['dismissed'] = array();
338 253 }
@@ -343,58 +258,35 @@
343 258 }
344 259 $this->update_list();
345 260 }
346 261
347 - /**
348 - * @return array
349 - */
350 262 public function unread() {
351 263 $messages = $this->get_messages( 'filter' );
352 264 $user_id = get_current_user_id();
353 -
354 265 foreach ( $messages as $t => $message ) {
355 266 if ( isset( $message['read'] ) && isset( $message['read'][ $user_id ] ) ) {
356 267 unset( $messages[ $t ] );
357 268 }
358 269 }
359 -
360 270 return $messages;
361 271 }
362 272
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 ) {
273 + public function unread_html() {
274 + $html = '';
371 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>';
372 278
373 - if ( ! $count ) {
374 - return '';
279 + /**
280 + * @since 4.06.01
281 + */
282 + $html = apply_filters( 'frm_inbox_badge', $html );
375 283 }
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 );
284 + return $html;
389 285 }
390 286
391 287 /**
392 288 * @since 4.05.02
393 - *
394 - * @param string $key
395 - *
396 - * @return void
397 289 */
398 290 public function remove( $key ) {
399 291 if ( isset( self::$messages[ $key ] ) ) {
400 292 unset( self::$messages[ $key ] );
@@ -401,80 +293,22 @@
401 293 $this->update_list();
402 294 }
403 295 }
404 296
405 - /**
406 - * @return void
407 - */
408 297 private function update_list() {
409 298 update_option( $this->option, self::$messages, 'no' );
410 299 }
411 300
412 - /**
413 - * Show a banner message if one is available.
414 - *
415 - * @return bool True if a banner is available and shown.
416 - */
417 301 public static function maybe_show_banner() {
418 302 if ( empty( self::$banner_messages ) ) {
419 - return false;
303 + return;
420 304 }
421 -
422 305 $message = end( self::$banner_messages );
423 - $cta = self::get_prepared_banner_cta( $message['cta'] );
424 -
425 306 require FrmAppHelper::plugin_path() . '/classes/views/inbox/banner.php';
426 - return true;
427 307 }
428 308
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 309 public static function maybe_disable_screen_options() {
475 310 self::$banner_messages = self::get_banner_messages();
476 -
477 311 if ( self::$banner_messages ) {
478 312 // disable screen options tab when displaying banner messages because it gets in the way of the banner.
479 313 add_filter( 'screen_options_show_screen', '__return_false' );
480 314 }
@@ -480,123 +314,16 @@
480 314 }
481 315 }
482 316
483 317 /**
484 - * Get all message with a "banner" message key defined.
485 - *
486 318 * @return array
487 319 */
488 320 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 321 $inbox = new self();
514 322 return array_filter(
515 323 $inbox->get_messages( 'filter' ),
516 - function ( $message ) use ( $key ) {
517 - return ! empty( $message[ $key ] );
324 + function( $message ) {
325 + return ! empty( $message['banner'] );
518 326 }
519 327 );
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;
601 328 }
602 329 }