← All changes | classes/models/FrmInbox.php +23 -105 6.27 → 6.13 View file →

		@@ -9,16 +9,10 @@
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	18	* @var array
		@@ -24,9 +18,9 @@
24	18	* @var 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();
		@@ -54,18 +48,14 @@
54	48	/**
55	49	* @since 4.05
56	50	*
57	51	* @param array|false $filter
58		- *
59		- * @return array
60	52	*/
61	53	public function get_messages( $filter = false ) {
62	54	$messages = self::$messages;
63		-
64	55	if ( $filter === 'filter' ) {
65	56	$this->filter_messages( $messages );
66	57	}
67		-
68	58	return $messages;
69	59	}
70	60
71	61	/**
		@@ -74,9 +64,8 @@
74	64	* @return void
75	65	*/
76	66	public function set_messages() {
77	67	self::$messages = get_option( $this->option );
78		-
79	68	if ( ! is_array( self::$messages ) ) {
80	69	self::$messages = array();
81	70	}
82	71
		@@ -94,10 +83,9 @@
94	83	* @return void
95	84	*/
96	85	private function add_api_messages() {
97	86	$api = $this->get_api_info();
98		-
99		- if ( ! $api ) {
	87	+ if ( empty( $api ) ) {
100	88	return;
101	89	}
102	90
103	91	foreach ( $api as $message ) {
		@@ -121,9 +109,9 @@
121	109	// Don't replace messages unless required.
122	110	return;
123	111	}
124	112
125		- if ( ! $this->within_valid_timeframe( $message ) ) {
	113	+ if ( $this->is_expired( $message ) ) {
126	114	return;
127	115	}
128	116
129	117	if ( isset( self::$messages[ $message['key'] ] ) ) {
		@@ -167,14 +155,13 @@
167	155	* @return void
168	156	*/
169	157	private function clean_messages() {
170	158	$removed = false;
171		-
172	159	foreach ( self::$messages as $t => $message ) {
173	160	$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 ) ) {
	161	+ $dismissed = ! empty( $message['dismissed'] ) && isset( $message['dismissed'][ get_current_user_id() ] ) && $message['dismissed'][ get_current_user_id() ] < strtotime( '-1 week' );
	162	+ $expired = $this->is_expired( $message );
	163	+ if ( $read || $expired || $dismissed ) {
177	164	unset( self::$messages[ $t ] );
178	165	$removed = true;
179	166	}
180	167	}
		@@ -186,58 +173,28 @@
186	173
187	174	/**
188	175	* @param array $messages
189	176	* @param string $type
190		- *
191	177	* @return void
192	178	*/
193	179	public function filter_messages( &$messages, $type = 'unread' ) {
194	180	$user_id = get_current_user_id();
195		-
196	181	foreach ( $messages as $k => $message ) {
197	182	$dismissed = isset( $message['dismissed'] ) && isset( $message['dismissed'][ $user_id ] );
198		-
199		- if ( empty( $k ) || ! $this->within_valid_timeframe( $message ) || ( $type === 'dismissed' ) !== $dismissed ) {
	183	+ if ( empty( $k ) || $this->is_expired( $message ) || ( $type === 'dismissed' ) !== $dismissed ) {
200	184	unset( $messages[ $k ] );
201	185	} elseif ( ! $this->is_for_user( $message ) ) {
202	186	unset( $messages[ $k ] );
203	187	}
204	188	}
205		-
206	189	$messages = apply_filters( 'frm_filter_inbox', $messages );
207	190	}
208	191
209	192	/**
210		- * Check if a message has started and is not expired.
211		- *
212		- * @since 6.25
213		- *
214	193	* @param array $message
215	194	*
216	195	* @return bool
217	196	*/
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	197	private function is_expired( $message ) {
241	198	return ! empty( $message['expires'] ) && $message['expires'] < time();
242	199	}
243	200
		@@ -244,18 +201,21 @@
244	201	/**
245	202	* Show different messages for different accounts.
246	203	*
247	204	* @param array $message
248		- *
249	205	* @return bool
250	206	*/
251	207	private function is_for_user( $message ) {
252		- if ( FrmApiHelper::is_for_user( $message ) ) {
	208	+ if ( ! isset( $message['who'] ) || $message['who'] === 'all' ) {
253	209	return true;
254	210	}
255		-
256	211	$who = (array) $message['who'];
257		-
	212	+ if ( in_array( 'all', $who, true ) || in_array( 'everyone', $who, true ) ) {
	213	+ return true;
	214	+ }
	215	+ if ( in_array( $this->get_user_type(), $who, true ) ) {
	216	+ return true;
	217	+ }
258	218	/**
259	219	* Allow for other special inbox cases in other add-ons.
260	220	*
261	221	* @since 6.8.1
		@@ -266,8 +226,16 @@
266	226	*/
267	227	return (bool) apply_filters( 'frm_inbox_message_is_for_user', false, $who, $message );
268	228	}
269	229
	230	+ private function get_user_type() {
	231	+ if ( ! FrmAppHelper::pro_is_installed() ) {
	232	+ return 'free';
	233	+ }
	234	+
	235	+ return FrmAddonsController::license_type();
	236	+ }
	237	+
270	238	/**
271	239	* @param string $key
272	240	*
273	241	* @return void
		@@ -288,14 +256,12 @@
288	256	/**
289	257	* @since 4.05.02
290	258	*
291	259	* @param string $key
292		- *
293	260	* @return void
294	261	*/
295	262	public function mark_unread( $key ) {
296	263	$is_read = isset( self::$messages[ $key ] ) && isset( self::$messages[ $key ]['read'] ) && isset( self::$messages[ $key ]['read'][ get_current_user_id() ] );
297		-
298	264	if ( $is_read ) {
299	265	unset( self::$messages[ $key ]['read'][ get_current_user_id() ] );
300	266	$this->update_list();
301	267	}
		@@ -330,9 +296,8 @@
330	296	* @return void
331	297	*/
332	298	private function dismiss_all() {
333	299	$user_id = get_current_user_id();
334		-
335	300	foreach ( self::$messages as $key => $message ) {
336	301	if ( ! isset( $message['dismissed'] ) ) {
337	302	self::$messages[ $key ]['dismissed'] = array();
338	303	}
		@@ -343,21 +308,16 @@
343	308	}
344	309	$this->update_list();
345	310	}
346	311
347		- /**
348		- * @return array
349		- */
350	312	public function unread() {
351	313	$messages = $this->get_messages( 'filter' );
352	314	$user_id = get_current_user_id();
353		-
354	315	foreach ( $messages as $t => $message ) {
355	316	if ( isset( $message['read'] ) && isset( $message['read'][ $user_id ] ) ) {
356	317	unset( $messages[ $t ] );
357	318	}
358	319	}
359		-
360	320	return $messages;
361	321	}
362	322
363	323	/**
		@@ -363,14 +323,12 @@
363	323	/**
364	324	* @since 6.8.4 The $filtered parameter was added.
365	325	*
366	326	* @param bool $filtered
367		- *
368	327	* @return string
369	328	*/
370	329	public function unread_html( $filtered = true ) {
371	330	$count = count( $this->unread() );
372		-
373	331	if ( ! $count ) {
374	332	return '';
375	333	}
376	334
		@@ -391,9 +349,8 @@
391	349	/**
392	350	* @since 4.05.02
393	351	*
394	352	* @param string $key
395		- *
396	353	* @return void
397	354	*/
398	355	public function remove( $key ) {
399	356	if ( isset( self::$messages[ $key ] ) ) {
		@@ -417,9 +374,8 @@
417	374	public static function maybe_show_banner() {
418	375	if ( empty( self::$banner_messages ) ) {
419	376	return false;
420	377	}
421		-
422	378	$message = end( self::$banner_messages );
423	379	$cta = self::get_prepared_banner_cta( $message['cta'] );
424	380
425	381	require FrmAppHelper::plugin_path() . '/classes/views/inbox/banner.php';
		@@ -431,9 +387,8 @@
431	387	*
432	388	* @since 6.8.4
433	389	*
434	390	* @param string $cta
435		- *
436	391	* @return string
437	392	*/
438	393	private static function get_prepared_banner_cta( $cta ) {
439	394	$cta = str_replace( 'button-secondary', 'button-primary', $cta );
		@@ -442,9 +397,8 @@
442	397	/**
443	398	* Replace a single href attribute in the CTA.
444	399	*
445	400	* @param array $matches The regex results for a single match.
446		- *
447	401	* @return string
448	402	*/
449	403	function ( $matches ) {
450	404	$url = $matches[2];
		@@ -454,13 +408,11 @@
454	408	return 'href="#"';
455	409	}
456	410
457	411	$query = array();
458		-
459	412	if ( isset( $parts['query'] ) ) {
460	413	parse_str( $parts['query'], $query );
461	414	}
462		-
463	415	$query['utm_medium'] = 'banner';
464	416	$parts['query'] = http_build_query( $query );
465	417	return 'href="' . $parts['scheme'] . '://' . $parts['host'] . $parts['path'] . '?' . $parts['query'] . '"';
466	418	},
		@@ -472,9 +424,8 @@
472	424	* @return void
473	425	*/
474	426	public static function maybe_disable_screen_options() {
475	427	self::$banner_messages = self::get_banner_messages();
476		-
477	428	if ( self::$banner_messages ) {
478	429	// disable screen options tab when displaying banner messages because it gets in the way of the banner.
479	430	add_filter( 'screen_options_show_screen', '__return_false' );
480	431	}
		@@ -505,9 +456,8 @@
505	456	*
506	457	* @since 6.8.4
507	458	*
508	459	* @param string $key The key we are checking for (ie. banner or slidein).
509		- *
510	460	* @return array
511	461	*/
512	462	private static function get_messages_with_key( $key ) {
513	463	$inbox = new self();
		@@ -538,9 +488,8 @@
538	488	* @return array|false
539	489	*/
540	490	public static function get_inbox_slide_in_value_for_js() {
541	491	$messages = self::get_slidein_messages();
542		-
543	492	if ( ! $messages ) {
544	493	return false;
545	494	}
546	495
		@@ -561,42 +510,11 @@
561	510
562	511	return array_reduce(
563	512	$keys_to_return,
564	513	function ( $total, $key ) use ( $message ) {
565		- $total[ $key ] = $message[ $key ] ?? '';
	514	+ $total[ $key ] = isset( $message[ $key ] ) ? $message[ $key ] : '';
566	515	return $total;
567	516	},
568	517	array()
569	518	);
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	519	}
602	520	}