Jetpack_Wizard_Banner::render_banner() - Code Metrics - Inspection of "Refactored display conditions. Some html fixes." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/implement_wizard_banner ( 2cf485...af534f )

unknown

created 2020-05-15 22:36 UTC

Jetpack_Wizard_Banner::render_banner() B

↳ Parent: Jetpack_Wizard_Banner

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	66
rs	8.7418
c	0
b	0
f	0

How to fix Long Method

<?php
/**
 * Displays the first page of the Wizard in a banner form
 *
 * @package Jetpack
 */

use Automattic\Jetpack\Assets;
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;

/**
 * Jetpack_Wizard_Banner
 **/
class Jetpack_Wizard_Banner {
	/**
	 * Jetpack_Wizard_Banner
	 *
	 * @var Jetpack_Wizard_Banner
	 **/
	private static $instance = null;

	/**
	 * Factory method
	 */
	public static function init() {
		if ( is_null( self::$instance ) ) {
			self::$instance = new Jetpack_Wizard_Banner();
		}

		return self::$instance;
	}

	/**
	 * Jetpack_Wizard_Banner constructor.
	 */
	private function __construct() {
		add_action( 'current_screen', array( $this, 'maybe_initialize_hooks' ) );
	}

	/**
	 * Initialize hooks to display the banner
	 */
	public function maybe_initialize_hooks() {
		if ( ! $this->can_be_displayed() ) {
			return;
		}

		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
		add_action( 'admin_notices', array( $this, 'render_banner' ) );
		add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_banner_scripts' ) );
	}

	/**
	 * Can we display the banner?
	 */
	private function can_be_displayed() {
		if ( ! Jetpack_Wizard::can_be_displayed() ) {
			return false;
		}

		// We already display the wizard at the Jetpack area.
		if ( false !== strpos( get_current_screen()->id, 'jetpack' ) ) {
			return false;
		}

		if ( ! current_user_can( 'jetpack_manage_modules' ) ) {
			return false;
		}

		// Kill if banner has been dismissed.
		if ( Jetpack_Options::get_option( 'dismissed_wizard_banner' ) ) {
			return false;
		}

		return true;
	}

	/**
	 * Enqueue JavaScript files.
	 */
	public function enqueue_banner_scripts() {
		wp_enqueue_script(
			'jetpack-wizard-banner-js',
			Assets::get_file_url_for_environment(
				'_inc/build/jetpack-wizard-banner.min.js',
				'_inc/jetpack-wizard-banner.js'
			),
			array( 'jquery' ),
			JETPACK__VERSION,
			true
		);

		wp_localize_script(
			'jetpack-wizard-banner-js',
			'jp_banner',
			array(
				'ajax_url'          => admin_url( 'admin-ajax.php' ),
				'wizardBannerNonce' => wp_create_nonce( 'jp-wizard-banner-nonce' ),
			)
		);
	}

	/**
	 * Include the needed styles
	 */
	public function admin_banner_styles() {
		wp_enqueue_style(
			'jetpack-wizard-banner',
			Assets::get_file_url_for_environment(
				'css/jetpack-wizard-banner.min.css',
				'css/jetpack-wizard-banner.css'
			),
			array(),
			JETPACK__VERSION
		);
	}

	/**
	 * AJAX callback
	 */
	public static function ajax_callback() {
		check_ajax_referer( 'jp-wizard-banner-nonce', 'nonce' );

		if (
			current_user_can( 'jetpack_manage_modules' )
			&& isset( $_REQUEST['dismissBanner'] )
		) {
			Jetpack_Options::update_option( 'dismissed_wizard_banner', 1 );
			wp_send_json_success();
		}

		wp_die();
	}

	/**
	 * Renders the Wizard Banner
	 *
	 * Since this HTML replicates the contents of _inc/client/setup-wizard/intro-page/index.jsx,
	 * every time one is changed, the other should also be.
	 */
	public function render_banner() {
		$jetpack_logo     = new Jetpack_Logo();
		$powering_up_logo = plugins_url( 'images/jetpack-powering-up.svg', JETPACK__PLUGIN_FILE );

		?>
		<div id="jp-wizard-banner" class="jp-wizard-banner">
			<span
				class="notice-dismiss wizard-banner-dismiss"
				title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>">
			</span>
			<div class="jp-emblem">
			<?php
				echo $jetpack_logo->get_jp_emblem_larger(); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
			?>
			</div>
			<img
				class="powering-up-img"
				width="200px"
				height="200px"
				src="<?php echo esc_url( $powering_up_logo ); ?>"
				alt="<?php esc_attr_e( 'A jetpack site powering up', 'jetpack' ); ?>"
			/>
			<h2 class="jp-wizard-banner-wizard-header">
				<?php esc_html_e( 'Set up Jetpack for better site security, performance, and more', 'jetpack' ); ?>
			</h2>
			<p class="jp-wizard-banner-wizard-paragraph">
				<?php esc_html_e( 'Jetpack is a cloud-powered tool built by Automattic.', 'jetpack' ); ?>
			</p>
			<p class="jp-wizard-banner-wizard-paragraph">
				<?php esc_html_e( 'Answer a few questions and we’ll help you secure, speed up, customize, and grow your WordPress website.', 'jetpack' ); ?>
			</p>
			<div class="jp-wizard-banner-wizard-intro-question">
				<h2>
					<?php
					/* translators: %s is the site name */
					printf(
						/* translators: %s is the site name */
						esc_html__( 'What will %s be used for?', 'jetpack' ),
						esc_html( get_bloginfo( 'name' ) )
					);
					?>
				</h2>
				<div class="jp-wizard-banner-wizard-answer-buttons">
					<a
						class="button button-primary jp-wizard-banner-wizard-button"
						href="<?php echo esc_url( Jetpack::admin_url( 'page=jetpack#/setup/income?use=personal' ) ); ?>"
					>
					<?php esc_html_e( 'Personal Use', 'jetpack' ); ?>
					</a>
					<a
						class="button button-primary jp-wizard-banner-wizard-button"
						href="<?php echo esc_url( Jetpack::admin_url( 'page=jetpack#/setup/income?use=business' ) ); ?>"
					>
						<?php esc_html_e( 'Business Use', 'jetpack' ); ?>
					</a>
				</div>
				<a
					class="jp-wizard-banner-wizard-skip-link"
					href="<?php echo esc_url( Jetpack::admin_url( 'page=jetpack#/setup/features' ) ); ?>"
				>
					<?php esc_html_e( 'Skip to recommended features', 'jetpack' ); ?>
				</a>
			</div>
		</div>
		<?php
	}
}


1		<?php
2		/**
3		* Displays the first page of the Wizard in a banner form
4		*
5		* @package Jetpack
6		*/
7
8		use Automattic\Jetpack\Assets;
9		use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
10
11		/**
12		* Jetpack_Wizard_Banner
13		**/
14		class Jetpack_Wizard_Banner {
15		/**
16		* Jetpack_Wizard_Banner
17		*
18		* @var Jetpack_Wizard_Banner
19		**/
20		private static $instance = null;
21
22		/**
23		* Factory method
24		*/
25		public static function init() {
26		if ( is_null( self::$instance ) ) {
27		self::$instance = new Jetpack_Wizard_Banner();
28		}
29
30		return self::$instance;
31		}
32
33		/**
34		* Jetpack_Wizard_Banner constructor.
35		*/
36		private function __construct() {
37		add_action( 'current_screen', array( $this, 'maybe_initialize_hooks' ) );
38		}
39
40		/**
41		* Initialize hooks to display the banner
42		*/
43		public function maybe_initialize_hooks() {
44		if ( ! $this->can_be_displayed() ) {
45		return;
46		}
47
48		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
49		add_action( 'admin_notices', array( $this, 'render_banner' ) );
50		add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_banner_scripts' ) );
51		}
52
53		/**
54		* Can we display the banner?
55		*/
56		private function can_be_displayed() {
57		if ( ! Jetpack_Wizard::can_be_displayed() ) {
58		return false;
59		}
60
61		// We already display the wizard at the Jetpack area.
62		if ( false !== strpos( get_current_screen()->id, 'jetpack' ) ) {
63		return false;
64		}
65
66		if ( ! current_user_can( 'jetpack_manage_modules' ) ) {
67		return false;
68		}
69
70		// Kill if banner has been dismissed.
71		if ( Jetpack_Options::get_option( 'dismissed_wizard_banner' ) ) {
72		return false;
73		}
74
75		return true;
76		}
77
78		/**
79		* Enqueue JavaScript files.
80		*/
81	View Code Duplication	public function enqueue_banner_scripts() {
82		wp_enqueue_script(
83		'jetpack-wizard-banner-js',
84		Assets::get_file_url_for_environment(
85		'_inc/build/jetpack-wizard-banner.min.js',
86		'_inc/jetpack-wizard-banner.js'
87		),
88		array( 'jquery' ),
89		JETPACK__VERSION,
90		true
91		);
92
93		wp_localize_script(
94		'jetpack-wizard-banner-js',
95		'jp_banner',
96		array(
97		'ajax_url' => admin_url( 'admin-ajax.php' ),
98		'wizardBannerNonce' => wp_create_nonce( 'jp-wizard-banner-nonce' ),
99		)
100		);
101		}
102
103		/**
104		* Include the needed styles
105		*/
106		public function admin_banner_styles() {
107		wp_enqueue_style(
108		'jetpack-wizard-banner',
109		Assets::get_file_url_for_environment(
110		'css/jetpack-wizard-banner.min.css',
111		'css/jetpack-wizard-banner.css'
112		),
113		array(),
114		JETPACK__VERSION
115		);
116		}
117
118		/**
119		* AJAX callback
120		*/
121	View Code Duplication	public static function ajax_callback() {
122		check_ajax_referer( 'jp-wizard-banner-nonce', 'nonce' );
123
124		if (
125		current_user_can( 'jetpack_manage_modules' )
126		&& isset( $_REQUEST['dismissBanner'] )
127		) {
128		Jetpack_Options::update_option( 'dismissed_wizard_banner', 1 );
129		wp_send_json_success();
130		}
131
132		wp_die();
133		}
134
135		/**
136		* Renders the Wizard Banner
137		*
138		* Since this HTML replicates the contents of _inc/client/setup-wizard/intro-page/index.jsx,
139		* every time one is changed, the other should also be.
140		*/
141		public function render_banner() {
142		$jetpack_logo = new Jetpack_Logo();
143		$powering_up_logo = plugins_url( 'images/jetpack-powering-up.svg', JETPACK__PLUGIN_FILE );
144
145		?>
146		<div id="jp-wizard-banner" class="jp-wizard-banner">
147		<span
148		class="notice-dismiss wizard-banner-dismiss"
149		title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>">
150		</span>
151		<div class="jp-emblem">
152		<?php
153		echo $jetpack_logo->get_jp_emblem_larger(); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
154		?>
155		</div>
156		<img
157		class="powering-up-img"
158		width="200px"
159		height="200px"
160		src="<?php echo esc_url( $powering_up_logo ); ?>"
161		alt="<?php esc_attr_e( 'A jetpack site powering up', 'jetpack' ); ?>"
162		/>
163		<h2 class="jp-wizard-banner-wizard-header">
164		<?php esc_html_e( 'Set up Jetpack for better site security, performance, and more', 'jetpack' ); ?>
165		</h2>
166		<p class="jp-wizard-banner-wizard-paragraph">
167		<?php esc_html_e( 'Jetpack is a cloud-powered tool built by Automattic.', 'jetpack' ); ?>
168		</p>
169		<p class="jp-wizard-banner-wizard-paragraph">
170		<?php esc_html_e( 'Answer a few questions and we’ll help you secure, speed up, customize, and grow your WordPress website.', 'jetpack' ); ?>
171		</p>
172		<div class="jp-wizard-banner-wizard-intro-question">
173		<h2>
174		<?php
175		/* translators: %s is the site name */
176		printf(
177		/* translators: %s is the site name */
178		esc_html__( 'What will %s be used for?', 'jetpack' ),
179		esc_html( get_bloginfo( 'name' ) )
180		);
181		?>
182		</h2>
183		<div class="jp-wizard-banner-wizard-answer-buttons">
184		<a
185		class="button button-primary jp-wizard-banner-wizard-button"
186		href="<?php echo esc_url( Jetpack::admin_url( 'page=jetpack#/setup/income?use=personal' ) ); ?>"
187		>
188		<?php esc_html_e( 'Personal Use', 'jetpack' ); ?>
189		</a>
190		<a
191		class="button button-primary jp-wizard-banner-wizard-button"
192		href="<?php echo esc_url( Jetpack::admin_url( 'page=jetpack#/setup/income?use=business' ) ); ?>"
193		>
194		<?php esc_html_e( 'Business Use', 'jetpack' ); ?>
195		</a>
196		</div>
197		<a
198		class="jp-wizard-banner-wizard-skip-link"
199		href="<?php echo esc_url( Jetpack::admin_url( 'page=jetpack#/setup/features' ) ); ?>"
200		>
201		<?php esc_html_e( 'Skip to recommended features', 'jetpack' ); ?>
202		</a>
203		</div>
204		</div>
205		<?php
206		}
207		}
208

Automattic / jetpack

Push — add/implement_wizard_banner ( 2cf485...af534f )

Jetpack_Wizard_Banner::render_banner() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like