← All changes | classes/models/FrmInbox.php +19 -88 6.28 → 6.19 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
		@@ -53,19 +47,15 @@
53	47
54	48	/**
55	49	* @since 4.05
56	50	*
57		- * @param false|string $filter
58		- *
59		- * @return array
	51	+ * @param array|false $filter
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 ) {
		@@ -111,10 +99,10 @@
111	99	* @return void
112	100	*/
113	101	public function add_message( $message ) {
114	102	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.
	103	+ // if the API response is invalid, $message may not be an array.
	104	+ // 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	105	return;
118	106	}
119	107
120	108	if ( isset( self::$messages[ $message['key'] ] ) && ! isset( $message['force'] ) ) {
		@@ -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,19 +155,16 @@
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 ) ) {
177		- continue;
	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 ) {
	164	+ unset( self::$messages[ $t ] );
	165	+ $removed = true;
178	166	}
179		-
180		- unset( self::$messages[ $t ] );
181		- $removed = true;
182	167	}
183	168
184	169	if ( $removed ) {
185	170	$this->update_list();
		@@ -188,58 +173,28 @@
188	173
189	174	/**
190	175	* @param array $messages
191	176	* @param string $type
192		- *
193	177	* @return void
194	178	*/
195	179	public function filter_messages( &$messages, $type = 'unread' ) {
196	180	$user_id = get_current_user_id();
197		-
198	181	foreach ( $messages as $k => $message ) {
199	182	$dismissed = isset( $message['dismissed'] ) && isset( $message['dismissed'][ $user_id ] );
200		-
201		- if ( ! $k || ! $this->within_valid_timeframe( $message ) || ( $type === 'dismissed' ) !== $dismissed ) {
	183	+ if ( empty( $k ) || $this->is_expired( $message ) || ( $type === 'dismissed' ) !== $dismissed ) {
202	184	unset( $messages[ $k ] );
203	185	} elseif ( ! $this->is_for_user( $message ) ) {
204	186	unset( $messages[ $k ] );
205	187	}
206	188	}
207		-
208	189	$messages = apply_filters( 'frm_filter_inbox', $messages );
209	190	}
210	191
211	192	/**
212		- * Check if a message has started and is not expired.
213		- *
214		- * @since 6.25
215		- *
216	193	* @param array $message
217	194	*
218	195	* @return bool
219	196	*/
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'] ) ? true : $message['starts'] <= time();
235		- }
236		-
237		- /**
238		- * @param array $message
239		- *
240		- * @return bool
241		- */
242	197	private function is_expired( $message ) {
243	198	return ! empty( $message['expires'] ) && $message['expires'] < time();
244	199	}
245	200
		@@ -246,9 +201,8 @@
246	201	/**
247	202	* Show different messages for different accounts.
248	203	*
249	204	* @param array $message
250		- *
251	205	* @return bool
252	206	*/
253	207	private function is_for_user( $message ) {
254	208	if ( FrmApiHelper::is_for_user( $message ) ) {
		@@ -290,20 +244,16 @@
290	244	/**
291	245	* @since 4.05.02
292	246	*
293	247	* @param string $key
294		- *
295	248	* @return void
296	249	*/
297	250	public function mark_unread( $key ) {
298	251	$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;
	252	+ if ( $is_read ) {
	253	+ unset( self::$messages[ $key ]['read'][ get_current_user_id() ] );
	254	+ $this->update_list();
302	255	}
303		-
304		- unset( self::$messages[ $key ]['read'][ get_current_user_id() ] );
305		- $this->update_list();
306	256	}
307	257
308	258	/**
309	259	* @param string $key
		@@ -334,9 +284,8 @@
334	284	* @return void
335	285	*/
336	286	private function dismiss_all() {
337	287	$user_id = get_current_user_id();
338		-
339	288	foreach ( self::$messages as $key => $message ) {
340	289	if ( ! isset( $message['dismissed'] ) ) {
341	290	self::$messages[ $key ]['dismissed'] = array();
342	291	}
		@@ -347,21 +296,16 @@
347	296	}
348	297	$this->update_list();
349	298	}
350	299
351		- /**
352		- * @return array
353		- */
354	300	public function unread() {
355	301	$messages = $this->get_messages( 'filter' );
356	302	$user_id = get_current_user_id();
357		-
358	303	foreach ( $messages as $t => $message ) {
359	304	if ( isset( $message['read'] ) && isset( $message['read'][ $user_id ] ) ) {
360	305	unset( $messages[ $t ] );
361	306	}
362	307	}
363		-
364	308	return $messages;
365	309	}
366	310
367	311	/**
		@@ -367,14 +311,12 @@
367	311	/**
368	312	* @since 6.8.4 The $filtered parameter was added.
369	313	*
370	314	* @param bool $filtered
371		- *
372	315	* @return string
373	316	*/
374	317	public function unread_html( $filtered = true ) {
375	318	$count = count( $this->unread() );
376		-
377	319	if ( ! $count ) {
378	320	return '';
379	321	}
380	322
		@@ -395,9 +337,8 @@
395	337	/**
396	338	* @since 4.05.02
397	339	*
398	340	* @param string $key
399		- *
400	341	* @return void
401	342	*/
402	343	public function remove( $key ) {
403	344	if ( isset( self::$messages[ $key ] ) ) {
		@@ -409,9 +350,9 @@
409	350	/**
410	351	* @return void
411	352	*/
412	353	private function update_list() {
413		- update_option( $this->option, self::$messages, false );
	354	+ update_option( $this->option, self::$messages, 'no' );
414	355	}
415	356
416	357	/**
417	358	* Show a banner message if one is available.
		@@ -421,9 +362,8 @@
421	362	public static function maybe_show_banner() {
422	363	if ( empty( self::$banner_messages ) ) {
423	364	return false;
424	365	}
425		-
426	366	$message = end( self::$banner_messages );
427	367	$cta = self::get_prepared_banner_cta( $message['cta'] );
428	368
429	369	require FrmAppHelper::plugin_path() . '/classes/views/inbox/banner.php';
		@@ -435,9 +375,8 @@
435	375	*
436	376	* @since 6.8.4
437	377	*
438	378	* @param string $cta
439		- *
440	379	* @return string
441	380	*/
442	381	private static function get_prepared_banner_cta( $cta ) {
443	382	$cta = str_replace( 'button-secondary', 'button-primary', $cta );
		@@ -446,25 +385,22 @@
446	385	/**
447	386	* Replace a single href attribute in the CTA.
448	387	*
449	388	* @param array $matches The regex results for a single match.
450		- *
451	389	* @return string
452	390	*/
453	391	function ( $matches ) {
454		- $url = $matches[2];
	392	+ $url = $matches[2];
	393	+ $parts = parse_url( $url );
455	394
456	395	if ( '#' === $url ) {
457	396	return 'href="#"';
458	397	}
459	398
460		- $parts = parse_url( $url );
461	399	$query = array();
462		-
463	400	if ( isset( $parts['query'] ) ) {
464	401	parse_str( $parts['query'], $query );
465	402	}
466		-
467	403	$query['utm_medium'] = 'banner';
468	404	$parts['query'] = http_build_query( $query );
469	405	return 'href="' . $parts['scheme'] . '://' . $parts['host'] . $parts['path'] . '?' . $parts['query'] . '"';
470	406	},
		@@ -476,11 +412,10 @@
476	412	* @return void
477	413	*/
478	414	public static function maybe_disable_screen_options() {
479	415	self::$banner_messages = self::get_banner_messages();
480		-
481	416	if ( self::$banner_messages ) {
482		- // Disable screen options tab when displaying banner messages because it gets in the way of the banner.
	417	+ // disable screen options tab when displaying banner messages because it gets in the way of the banner.
483	418	add_filter( 'screen_options_show_screen', '__return_false' );
484	419	}
485	420	}
486	421
		@@ -509,9 +444,8 @@
509	444	*
510	445	* @since 6.8.4
511	446	*
512	447	* @param string $key The key we are checking for (ie. banner or slidein).
513		- *
514	448	* @return array
515	449	*/
516	450	private static function get_messages_with_key( $key ) {
517	451	$inbox = new self();
		@@ -542,9 +476,8 @@
542	476	* @return array|false
543	477	*/
544	478	public static function get_inbox_slide_in_value_for_js() {
545	479	$messages = self::get_slidein_messages();
546		-
547	480	if ( ! $messages ) {
548	481	return false;
549	482	}
550	483
		@@ -565,9 +498,9 @@
565	498
566	499	return array_reduce(
567	500	$keys_to_return,
568	501	function ( $total, $key ) use ( $message ) {
569		- $total[ $key ] = $message[ $key ] ?? '';
	502	+ $total[ $key ] = isset( $message[ $key ] ) ? $message[ $key ] : '';
570	503	return $total;
571	504	},
572	505	array()
573	506	);
		@@ -593,14 +526,12 @@
593	526	*/
594	527	public static function check_for_error() {
595	528	$inbox = new self();
596	529	$messages = $inbox->get_messages( 'filter' );
597		-
598	530	foreach ( $messages as $message ) {
599	531	if ( is_array( $message ) && isset( $message['type'] ) && 'error' === $message['type'] ) {
600	532	return $message;
601	533	}
602	534	}
603		-
604	535	return false;
605	536	}
606	537	}