visualizer / vendor / codeinwp / themeisle-sdk / src / Modules / Welcome.php

Welcome.php in Visualizer – Tables & Charts Manager with Built-in AI Generator 3.10.8, at vendor/codeinwp/themeisle-sdk/src/Modules/Welcome.php

194 lines 5.2 KB

Raw Download Zip

1	<?php
2	/**
3	* The welcome model class for ThemeIsle SDK
4	*
5	* Here's how to hook it in your plugin or theme:
6	* ```php
7	* add_filter( '<product_slug>_welcome_metadata', function() {
8	* return [
9	* 'is_enabled' => <condition_if_pro_available>,
10	* 'pro_name' => 'Product PRO name',
11	* 'logo' => '<path_to_logo>',
12	* 'cta_link' => tsdk_utmify( 'https://link_to_upgrade.with/?discount=<discountCode>')
13	* ];
14	* } );
15	* ```
16	*
17	* @package ThemeIsleSDK
18	* @subpackage Modules
19	* @copyright Copyright (c) 2023, Bogdan Preda
20	* @license http://opensource.org/licenses/gpl-3.0.php GNU Public License
21	* @since 1.0.0
22	*/
23
24	namespace ThemeisleSDK\Modules;
25
26	// Exit if accessed directly.
27	use ThemeisleSDK\Common\Abstract_Module;
28
29	if ( ! defined( 'ABSPATH' ) ) {
30	exit;
31	}
32
33	/**
34	* Promotions module for ThemeIsle SDK.
35	*/
36	class Welcome extends Abstract_Module {
37
38	/**
39	* Debug mode.
40	*
41	* @var bool
42	*/
43	private $debug = false;
44
45	/**
46	* Welcome metadata.
47	*
48	* @var array
49	*/
50	private $welcome_discounts = array();
51
52	/**
53	* Check that we can load this module.
54	*
55	* @param \ThemeisleSDK\Product $product The product.
56	*
57	* @return bool
58	*/
59	public function can_load( $product ) {
60	$this->debug = apply_filters( 'themeisle_sdk_welcome_debug', $this->debug );
61	$welcome_metadata = apply_filters( $product->get_key() . '_welcome_metadata', array() );
62
63	$is_welcome_enabled = $this->is_welcome_meta_valid( $welcome_metadata );
64
65	if ( $is_welcome_enabled ) {
66	$this->welcome_discounts[ $product->get_key() ] = $welcome_metadata;
67	}
68
69	return $this->debug \|\| $is_welcome_enabled;
70	}
71
72	/**
73	* Check that the metadata is valid and the welcome is enabled.
74	*
75	* @param array $welcome_metadata The metadata to validate.
76	*
77	* @return bool
78	*/
79	private function is_welcome_meta_valid( $welcome_metadata ) {
80	return ! empty( $welcome_metadata ) && isset( $welcome_metadata['is_enabled'] ) && $welcome_metadata['is_enabled'];
81	}
82
83	/**
84	* Load the module.
85	*
86	* @param \ThemeisleSDK\Product $product The product.
87	*
88	* @return $this
89	*/
90	public function load( $product ) {
91	if ( ! current_user_can( 'install_plugins' ) ) {
92	return;
93	}
94
95	$this->product = $product;
96	if ( ! $this->is_time_to_show_welcome() && $this->debug === false ) {
97	return;
98	}
99
100	add_filter( 'themeisle_sdk_registered_notifications', [ $this, 'add_notification' ], 99, 1 );
101
102	return $this;
103	}
104
105	/**
106	* Check if it's time to show the welcome.
107	*
108	* @return bool
109	*/
110	private function is_time_to_show_welcome() {
111	// if 7 days from install have not passed, don't show the welcome.
112	if ( $this->product->get_install_time() + 7 * DAY_IN_SECONDS > time() ) {
113	return false;
114	}
115
116	// if 12 days from install have passed, don't show the welcome ( after 7 days for 5 days ).
117	if ( $this->product->get_install_time() + 12 * DAY_IN_SECONDS < time() ) {
118	return false;
119	}
120
121	return true;
122	}
123
124	/**
125	* Add the welcome notification.
126	* Will block all other notifications if a welcome notification is present.
127	*
128	* @return array
129	*/
130	public function add_notification( $all_notifications ) {
131	if ( empty( $this->welcome_discounts ) ) {
132	return $all_notifications;
133	}
134
135	if ( ! isset( $this->welcome_discounts[ $this->product->get_key() ] ) ) {
136	return $all_notifications;
137	}
138
139	// filter out the notifications that are not welcome upsells
140	// if we arrived here we will have at least one welcome upsell
141	$all_notifications = array_filter(
142	$all_notifications,
143	function( $notification ) {
144	return strpos( $notification['id'], '_welcome_upsell_flag' ) !== false;
145	}
146	);
147
148	$offer = $this->welcome_discounts[ $this->product->get_key() ];
149
150	$response = [];
151	$logo = isset( $offer['logo'] ) ? $offer['logo'] : '';
152	$pro_name = isset( $offer['pro_name'] ) ? $offer['pro_name'] : $this->product->get_friendly_name() . ' PRO';
153
154	$link = $offer['cta_link'];
155
156	$message = apply_filters( $this->product->get_key() . '_welcome_upsell_message', '<p>You\'ve been using <b>{product}</b> for 7 days now and we appreciate your loyalty! We also want to make sure you\'re getting the most out of our product. That\'s why we\'re offering you a special deal - upgrade to <b>{pro_product}</b> in the next 5 days and receive a discount of <b>up to 30%</b>. <a href="{cta_link}" target="_blank">Upgrade now</a> and unlock all the amazing features of <b>{pro_product}</b>!</p>' );
157
158	$button_submit = apply_filters( $this->product->get_key() . '_feedback_review_button_do', 'Upgrade Now!' );
159	$button_cancel = apply_filters( $this->product->get_key() . '_feedback_review_button_cancel', 'No, thanks.' );
160	$message = str_replace(
161	[ '{product}', '{pro_product}', '{cta_link}' ],
162	[
163	$this->product->get_friendly_name(),
164	$pro_name,
165	$link,
166	],
167	$message
168	);
169
170	$all_notifications[] = [
171	'id' => $this->product->get_key() . '_welcome_upsell_flag',
172	'message' => $message,
173	'img_src' => $logo,
174	'ctas' => [
175	'confirm' => [
176	'link' => $link,
177	'text' => $button_submit,
178	],
179	'cancel' => [
180	'link' => '#',
181	'text' => $button_cancel,
182	],
183	],
184	'type' => 'info',
185	];
186
187	$key = array_rand( $all_notifications );
188	$response[] = $all_notifications[ $key ];
189
190	return $response;
191	}
192
193	}
194