class-jetpack-recommendations-banner.php — Jetpack – WP Security, Backup, Speed, & Growth 13.0.2

jetpack / class-jetpack-recommendations-banner.php

jetpack Last commit date

class-jetpack-recommendations-banner.php

287 lines

1	<?php
2	/**
3	* Displays the site type recommendations question as a banner.
4	* DEPRECATED in v 13.0
5	*
6	* @package automattic/jetpack
7	*/
8
9	use Automattic\Jetpack\Assets;
10	use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
11	use Automattic\Jetpack\Identity_Crisis;
12	use Automattic\Jetpack\Tracking;
13
14	/**
15	* Jetpack_Recommendations_Banner
16	**/
17	class Jetpack_Recommendations_Banner {
18	/**
19	* Jetpack_Recommendations_Banner
20	*
21	* @var Jetpack_Recommendations_Banner
22	**/
23	private static $instance = null;
24
25	/**
26	* Factory method
27	*/
28	public static function init() {
29	if ( self::$instance === null ) {
30	self::$instance = new Jetpack_Recommendations_Banner();
31	}
32
33	return self::$instance;
34	}
35
36	/**
37	* Jetpack_Recommendations_Banner constructor.
38	*/
39	private function __construct() {
40	add_action( 'current_screen', array( $this, 'maybe_initialize_hooks' ) );
41	}
42
43	/**
44	* Initialize hooks to display the banner
45	*
46	* @since 9.7 Added the $current_screen parameter.
47	*
48	* @param \WP_Screen $current_screen Current WordPress screen.
49	*/
50	public function maybe_initialize_hooks( $current_screen ) {
51	if ( ! static::can_be_displayed() ) {
52	return;
53	}
54
55	if ( Jetpack_Connection_Banner::can_be_displayed( $current_screen ) ) {
56	// We don't want to overcrowd the screen with both the Connection banner and the Recommendations banner.
57	return;
58	}
59
60	add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
61	add_action( 'admin_notices', array( $this, 'render_banner' ) );
62	add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_banner_scripts' ) );
63	}
64
65	/**
66	* Determines if the banner can be displayed
67	*/
68	public static function can_be_displayed() {
69	if ( ! Jetpack_Recommendations::is_banner_enabled() ) {
70	return false;
71	}
72
73	// Only the dashboard and plugins pages should see the banner.
74	if ( ! in_array( get_current_screen()->id, array( 'dashboard', 'plugins' ), true ) ) {
75	return false;
76	}
77
78	if ( ! current_user_can( 'jetpack_manage_modules' ) ) {
79	return false;
80	}
81
82	if ( Jetpack_Options::get_option( 'recommendations_banner_dismissed' ) ) {
83	return false;
84	}
85
86	if ( ! in_array(
87	Jetpack_Options::get_option( 'recommendations_step', 'not-started' ),
88	array(
89	'not-started',
90	'site-type-question',
91	),
92	true
93	) ) {
94	return false;
95	}
96
97	if ( Identity_Crisis::has_identity_crisis() ) {
98	return false;
99	}
100
101	return true;
102	}
103
104	/**
105	* Handles storing the user responses in the banner.
106	*/
107	public static function ajax_callback() {
108	check_ajax_referer( 'jp-recommendations-banner-nonce', 'nonce' );
109
110	if ( ! current_user_can( 'jetpack_manage_modules' ) ) {
111	wp_die();
112	}
113
114	$tracking = new Tracking();
115
116	if ( isset( $_REQUEST['dismissBanner'] ) && 'true' === $_REQUEST['dismissBanner'] ) {
117	Jetpack_Options::update_option( 'recommendations_banner_dismissed', 1 );
118	$tracking->record_user_event( 'recommendations_banner_dismissed' );
119	wp_send_json_success();
120	wp_die();
121	}
122
123	$data = Jetpack_Recommendations::get_recommendations_data();
124
125	$tracking_answers = array();
126
127	if ( isset( $_REQUEST['personal'] ) && is_string( $_REQUEST['personal'] ) ) {
128	$value = 'true' === $_REQUEST['personal'] ? true : false;
129	$data['site-type-personal'] = $value;
130	$tracking_answers['personal'] = $value;
131	}
132
133	if ( isset( $_REQUEST['builder'] ) && is_string( $_REQUEST['builder'] ) ) {
134	$value = 'true' === $_REQUEST['builder'] ? true : false;
135	$data['site-type-agency'] = $value;
136	$tracking_answers['builder'] = $value;
137	}
138
139	if ( isset( $_REQUEST['store'] ) && is_string( $_REQUEST['store'] ) ) {
140	$value = 'true' === $_REQUEST['store'] ? true : false;
141	$data['site-type-store'] = $value;
142	$tracking_answers['store'] = $value;
143	}
144
145	Jetpack_Recommendations::update_recommendations_data( $data );
146	Jetpack_Options::update_option( 'recommendations_step', 'banner-completed' );
147
148	$tracking->record_user_event( 'recommendations_banner_answered', $tracking_answers );
149
150	wp_send_json_success();
151	wp_die();
152	}
153
154	/**
155	* Enqueue JavaScript files.
156	*/
157	public function enqueue_banner_scripts() {
158	wp_enqueue_script(
159	'jetpack-recommendations-banner-js',
160	Assets::get_file_url_for_environment(
161	'_inc/build/jetpack-recommendations-banner.min.js',
162	'_inc/jetpack-recommendations-banner.js'
163	),
164	array( 'jquery' ),
165	JETPACK__VERSION,
166	true
167	);
168
169	wp_localize_script(
170	'jetpack-recommendations-banner-js',
171	'jp_banner',
172	array(
173	'nonce' => wp_create_nonce( 'jp-recommendations-banner-nonce' ),
174	'ajax_url' => admin_url( 'admin-ajax.php' ),
175	'recommendations_url' => admin_url( 'admin.php?page=jetpack#/recommendations' ),
176	)
177	);
178	}
179
180	/**
181	* Include the needed styles
182	*/
183	public function admin_banner_styles() {
184	wp_enqueue_style(
185	'jetpack-recommendations-banner',
186	Assets::get_file_url_for_environment(
187	'css/jetpack-recommendations-banner.min.css',
188	'css/jetpack-recommendations-banner.css'
189	),
190	array(),
191	JETPACK__VERSION
192	);
193	}
194
195	/**
196	* Renders the Recommendations Banner
197	*/
198	public function render_banner() {
199	$jetpack_logo = new Jetpack_Logo();
200	$site_name = get_bloginfo( 'name' );
201	?>
202	<div id="jp-recommendations-banner-main" class="jp-recommendations-banner-main">
203	<div class="jp-recommendations-banner__content">
204	<div class="jp-recommendations-banner__logo">
205	<?php
206	echo $jetpack_logo->get_jp_emblem_larger(); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
207	?>
208	</div>
209	<h1 class="jp-recommendations-banner__question">
210	<?php
211	/* translators: placeholder is the name of the website */
212	printf( esc_html__( 'Tell us more about %s?', 'jetpack' ), esc_html( $site_name ) );
213	?>
214	</h1>
215	<p class="jp-recommendations-banner__description">
216	<?php esc_html_e( 'To help you get the most from Jetpack, tell us about your site. Check all that apply:', 'jetpack' ); ?>
217	</p>
218	<div class="jp-recommendations-banner__answer">
219	<form id="jp-recommendations-banner__form" class="jp-recommendations-banner__form">
220	<div class="jp-recommendations-banner__checkboxes">
221	<?php $this->render_checkbox( 'builder', __( 'I build or manage this site for a client', 'jetpack' ) ); ?>
222	<?php $this->render_checkbox( 'store', __( 'This is an e-commerce store', 'jetpack' ) ); ?>
223	<?php $this->render_checkbox( 'personal', __( 'This is a personal site', 'jetpack' ) ); ?>
224	</div>
225	</form>
226	<a id="jp-recommendations-banner__continue-button" class="jp-banner-cta-button">
227	<?php esc_html_e( 'Continue', 'jetpack' ); ?>
228	</a>
229	<div class="jp-recommendations-banner__continue-description">
230	<?php esc_html_e( 'All Jetpack’s great features await you and we’ll recommend some of our favorites', 'jetpack' ); ?>
231	</div>
232	</div>
233	</div>
234	<div class="jp-recommendations-banner__illustration-container">
235	<button id="jp-recommendations-banner__notice-dismiss" class="jp-recommendations-banner__notice-dismiss">
236	<svg class="jp-recommendations-banner__svg-dismiss" width="25" height="24" viewBox="0 0 25 24" fill="none" xmlns="http://www.w3.org/2000/svg" aria-hidden="true">
237	<path fill-rule="evenodd" d="M12.5232 2C7.02034 2 2.57227 6.47 2.57227 12C2.57227 17.53 7.02034 22 12.5232 22C18.0261 22 22.4742 17.53 22.4742 12C22.4742 6.47 18.0261 2 12.5232 2ZM15.1005 8L12.5232 10.59L9.94591 8L8.54283 9.41L11.1201 12L8.54283 14.59L9.94591 16L12.5232 13.41L15.1005 16L16.5036 14.59L13.9263 12L16.5036 9.41L15.1005 8ZM4.56245 12C4.56245 16.41 8.13484 20 12.5232 20C16.9116 20 20.484 16.41 20.484 12C20.484 7.59 16.9116 4 12.5232 4C8.13484 4 4.56245 7.59 4.56245 12Z" />
238	</svg>
239	<span><?php esc_attr_e( 'Dismiss', 'jetpack' ); ?></span>
240	</button>
241	<picture>
242	<source
243	type="image/webp"
244	srcset="<?php echo esc_url( $this->img_path( 1, 'webp' ) ); ?> 1x, <?php echo esc_url( $this->img_path( 2, 'webp' ) ); ?> 2x">
245	<img
246	class="jp-recommendations-banner__illustration-foreground"
247	srcset="<?php echo esc_url( $this->img_path( 2 ) ); ?> 2x"
248	src="<?php echo esc_url( $this->img_path() ); ?>"
249	alt="">
250	</picture>
251	</div>
252	</div>
253	<?php
254	}
255
256	/**
257	* Renders a checkbox.
258	*
259	* @param string $name The name to give the form input.
260	* @param string $title The title to put on the checkbox.
261	*/
262	private function render_checkbox( $name, $title ) {
263	?>
264	<label for="<?php echo esc_html( $name ); ?>" class="jp-recommendations-answer__checkbox-label">
265	<input id="<?php echo esc_html( $name ); ?>" name="<?php echo esc_html( $name ); ?>" type="checkbox" tabindex="-1"/>
266	<div class="jp-recommendations-answer__title">
267	<?php echo esc_html( $title ); ?>
268	</div>
269	</label>
270	<?php
271	}
272
273	/**
274	* Returns the path of the banner image for the specified version.
275	*
276	* @param string $res Requested resolution.
277	* @param string $format Requested format.
278	* @return string Path
279	*/
280	private function img_path( $res = 1, $format = 'png' ) {
281	$suffix = 2 === $res ? '-2x' : '';
282	$ext = in_array( $format, array( 'webp', 'png' ), true ) ? $format : 'png';
283
284	return plugins_url( "images/recommendations/assistant-site-type$suffix.$ext", JETPACK__PLUGIN_FILE );
285	}
286	}
287