Issues in class.jetpack-admin-page.php - New Issues - Inspection of "Theme Promo Card: Improve readability" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — fix/typo-pro-promo ( e5832e...fc698e )

unknown

created 2018-06-07 15:00 UTC

_inc/lib/admin-pages/class.jetpack-admin-page.php (2 issues)

Labels

Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

// Shared logic between Jetpack admin pages
abstract class Jetpack_Admin_Page {
	// Add page specific actions given the page hook
	abstract function add_page_actions( $hook );

	// Create a menu item for the page and returns the hook
	abstract function get_page_hook();

	// Enqueue and localize page specific scripts
	abstract function page_admin_scripts();

	// Render page specific HTML
	abstract function page_render();

	/**
	 * Should we block the page rendering because the site is in IDC?
	 * @var bool
	 */
	static $block_page_rendering_for_idc;

	/**
	 * Flag to know if we already checked the plan.
	 *
	 * @since 4.4.0
	 *
	 * @var bool
	 */
	static $plan_checked = false;
class A {
    var $property;
}

	/**
	 * Function called after admin_styles to load any additional needed styles.
	 *
	 * @since 4.3.0
	 */
	function additional_styles() {}

	function __construct() {
		$this->jetpack = Jetpack::init();
		self::$block_page_rendering_for_idc = (
			Jetpack::validate_sync_error_idc_option() && ! Jetpack_Options::get_option( 'safe_mode_confirmed' )
		);
	}

	function add_actions() {

		// If user is not an admin and site is in Dev Mode, don't do anything
		if ( ! current_user_can( 'manage_options' ) && Jetpack::is_development_mode() ) {
			return;
		}

		// Don't add in the modules page unless modules are available!
		if ( $this->dont_show_if_not_active && ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
			return;
		}

		// Initialize menu item for the page in the admin
		$hook = $this->get_page_hook();

		// Attach hooks common to all Jetpack admin pages based on the created
		// hook
		add_action( "load-$hook",                array( $this, 'admin_help'      ) );
		add_action( "load-$hook",                array( $this, 'admin_page_load' ) );
		add_action( "admin_head-$hook",          array( $this, 'admin_head'      ) );

		add_action( "admin_print_styles-$hook",  array( $this, 'admin_styles'    ) );
		add_action( "admin_print_scripts-$hook", array( $this, 'admin_scripts'   ) );

		if ( ! self::$block_page_rendering_for_idc ) {
			add_action( "admin_print_styles-$hook", array( $this, 'additional_styles' ) );
		}

		// Check if the site plan changed and deactivate modules accordingly.
		add_action( 'current_screen', array( $this, 'check_plan_deactivate_modules' ) );

		// Attach page specific actions in addition to the above
		$this->add_page_actions( $hook );
	}

	function admin_head() {
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
			/**
			 * Fires in the <head> of a particular Jetpack configuation page.
			 *
			 * The dynamic portion of the hook name, `$_GET['configure']`,
			 * refers to the slug of module, such as 'stats', 'sso', etc.
			 * A complete hook for the latter would be
			 * 'jetpack_module_configuation_head_sso'.
			 *
			 * @since 3.0.0
			 */
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
		}
	}

	// Render the page with a common top and bottom part, and page specific content
	function render() {
		// We're in an IDC: we need a decision made before we show the UI again.
		if ( self::$block_page_rendering_for_idc ) {
			return;
		}

		$this->page_render();
	}

	function admin_help() {
		$this->jetpack->admin_help();
	}

	function admin_page_load() {
		// This is big.  For the moment, just call the existing one.
		$this->jetpack->admin_page_load();
	}

	function admin_page_top() {
		include_once( JETPACK__PLUGIN_DIR . '_inc/header.php' );
	}

	function admin_page_bottom() {
		include_once( JETPACK__PLUGIN_DIR . '_inc/footer.php' );
	}

	// Add page specific scripts and jetpack stats for all menu pages
	function admin_scripts() {
		$this->page_admin_scripts(); // Delegate to inheriting class
		add_action( 'admin_footer', array( $this->jetpack, 'do_stats' ) );
	}

	// Enqueue the Jetpack admin stylesheet
	function admin_styles() {
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';

		wp_enqueue_style( 'jetpack-admin', plugins_url( "css/jetpack-admin{$min}.css", JETPACK__PLUGIN_FILE ), array( 'genericons' ), JETPACK__VERSION . '-20121016' );
		wp_style_add_data( 'jetpack-admin', 'rtl', 'replace' );
		wp_style_add_data( 'jetpack-admin', 'suffix', $min );
	}

	/**
	 * Checks if WordPress version is too old to have REST API.
	 *
	 * @since 4.3
	 *
	 * @return bool
	 */
	function is_wp_version_too_old() {
		global $wp_version;
		return ( ! function_exists( 'rest_api_init' ) || version_compare( $wp_version, '4.4-z', '<=' ) );
	}

	/**
	 * Checks if REST API is enabled.
	 *
	 * @since 4.4.2
	 *
	 * @return bool
	 */
	function is_rest_api_enabled() {
		return
			/** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */
			apply_filters( 'rest_enabled', true ) &&
			/** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */
			apply_filters( 'rest_jsonp_enabled', true ) &&
			/** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */
			apply_filters( 'rest_authentication_errors', true );
	}

	/**
	 * Checks the site plan and deactivates modules that were active but are no longer included in the plan.
	 *
	 * @since 4.4.0
	 *
	 * @param $page
	 *
	 * @return bool|array
	 */
	function check_plan_deactivate_modules( $page ) {
		if (
			Jetpack::is_development_mode()
			|| ! in_array(
				$page->base,
				array(
					'toplevel_page_jetpack',
					'admin_page_jetpack_modules',
					'jetpack_page_vaultpress',
					'jetpack_page_stats',
					'jetpack_page_akismet-key-config'
				)
			)
			|| true === self::$plan_checked
		) {
			return false;
		}

		self::$plan_checked = true;
		$previous = get_option( 'jetpack_active_plan', '' );
		$current = Jetpack_Core_Json_Api_Endpoints::site_data();
		if ( ! $current || is_wp_error( $current ) ) {

			// If we can't get information about the current plan we don't do anything
			self::$plan_checked = true;
			return;
		}

		$to_deactivate = array();
		if ( isset( $current->plan->product_slug ) ) {
			if (
				empty( $previous )
				|| ! isset( $previous['product_slug'] )
				|| $previous['product_slug'] !== $current->plan->product_slug
			) {
				$active = Jetpack::get_active_modules();
				switch ( $current->plan->product_slug ) {
					case 'jetpack_free':
						$to_deactivate = array( 'seo-tools', 'videopress', 'google-analytics', 'wordads', 'search' );
						break;
					case 'jetpack_personal':
					case 'jetpack_personal_monthly':
						$to_deactivate = array( 'seo-tools', 'videopress', 'google-analytics', 'wordads', 'search' );
						break;
					case 'jetpack_premium':
					case 'jetpack_premium_monthly':
						$to_deactivate = array( 'seo-tools', 'google-analytics', 'search' );
						break;
				}
				$to_deactivate = array_intersect( $active, $to_deactivate );
				if ( ! empty( $to_deactivate ) ) {
					Jetpack::update_active_modules( array_filter( array_diff( $active, $to_deactivate ) ) );
				}
			}
		}
		return array(
			'previous'   => $previous,
			'current'    => $current,
			'deactivate' => $to_deactivate
		);
	}
}


1		<?php
2
3		// Shared logic between Jetpack admin pages
4		abstract class Jetpack_Admin_Page {
5		// Add page specific actions given the page hook
6		abstract function add_page_actions( $hook );
7
8		// Create a menu item for the page and returns the hook
9		abstract function get_page_hook();
10
11		// Enqueue and localize page specific scripts
12		abstract function page_admin_scripts();
13
14		// Render page specific HTML
15		abstract function page_render();
16
17		/**
18		* Should we block the page rendering because the site is in IDC?
19		* @var bool
20		*/
21		static $block_page_rendering_for_idc;
22
23		/**
24		* Flag to know if we already checked the plan.
25		*
26		* @since 4.4.0
27		*
28		* @var bool
29		*/
30		static $plan_checked = false;
		0 ignored issues – show Coding Style introduced 2018-02-13 15:03 UTC by Report Bug Copy Issue Report Show Similar Issues like this The visibility should be declared for property `$plan_checked`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
31
32		/**
33		* Function called after admin_styles to load any additional needed styles.
34		*
35		* @since 4.3.0
36		*/
37		function additional_styles() {}
38
39		function __construct() {
40		$this->jetpack = Jetpack::init();
41		self::$block_page_rendering_for_idc = (
42		Jetpack::validate_sync_error_idc_option() && ! Jetpack_Options::get_option( 'safe_mode_confirmed' )
43		);
44		}
45
46		function add_actions() {
47
48		// If user is not an admin and site is in Dev Mode, don't do anything
49		if ( ! current_user_can( 'manage_options' ) && Jetpack::is_development_mode() ) {
50		return;
51		}
52
53		// Don't add in the modules page unless modules are available!
54		if ( $this->dont_show_if_not_active && ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
55		return;
56		}
57
58		// Initialize menu item for the page in the admin
59		$hook = $this->get_page_hook();
60
61		// Attach hooks common to all Jetpack admin pages based on the created
62		// hook
63		add_action( "load-$hook", array( $this, 'admin_help' ) );
64		add_action( "load-$hook", array( $this, 'admin_page_load' ) );
65		add_action( "admin_head-$hook", array( $this, 'admin_head' ) );
66
67		add_action( "admin_print_styles-$hook", array( $this, 'admin_styles' ) );
68		add_action( "admin_print_scripts-$hook", array( $this, 'admin_scripts' ) );
69
70		if ( ! self::$block_page_rendering_for_idc ) {
71		add_action( "admin_print_styles-$hook", array( $this, 'additional_styles' ) );
72		}
73
74		// Check if the site plan changed and deactivate modules accordingly.
75		add_action( 'current_screen', array( $this, 'check_plan_deactivate_modules' ) );
76
77		// Attach page specific actions in addition to the above
78		$this->add_page_actions( $hook );
79		}
80
81		function admin_head() {
82	View Code Duplication	if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
83		/**
84		* Fires in the <head> of a particular Jetpack configuation page.
85		*
86		* The dynamic portion of the hook name, `$_GET['configure']`,
87		* refers to the slug of module, such as 'stats', 'sso', etc.
88		* A complete hook for the latter would be
89		* 'jetpack_module_configuation_head_sso'.
90		*
91		* @since 3.0.0
92		*/
93		do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
94		}
95		}
96
97		// Render the page with a common top and bottom part, and page specific content
98		function render() {
99		// We're in an IDC: we need a decision made before we show the UI again.
100		if ( self::$block_page_rendering_for_idc ) {
101		return;
102		}
103
104		$this->page_render();
105		}
106
107		function admin_help() {
108		$this->jetpack->admin_help();
109		}
110
111		function admin_page_load() {
112		// This is big. For the moment, just call the existing one.
113		$this->jetpack->admin_page_load();
114		}
115
116		function admin_page_top() {
117		include_once( JETPACK__PLUGIN_DIR . '_inc/header.php' );
118		}
119
120		function admin_page_bottom() {
121		include_once( JETPACK__PLUGIN_DIR . '_inc/footer.php' );
122		}
123
124		// Add page specific scripts and jetpack stats for all menu pages
125		function admin_scripts() {
126		$this->page_admin_scripts(); // Delegate to inheriting class
127		add_action( 'admin_footer', array( $this->jetpack, 'do_stats' ) );
128		}
129
130		// Enqueue the Jetpack admin stylesheet
131		function admin_styles() {
132		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
133
134		wp_enqueue_style( 'jetpack-admin', plugins_url( "css/jetpack-admin{$min}.css", JETPACK__PLUGIN_FILE ), array( 'genericons' ), JETPACK__VERSION . '-20121016' );
135		wp_style_add_data( 'jetpack-admin', 'rtl', 'replace' );
136		wp_style_add_data( 'jetpack-admin', 'suffix', $min );
137		}
138
139		/**
140		* Checks if WordPress version is too old to have REST API.
141		*
142		* @since 4.3
143		*
144		* @return bool
145		*/
146		function is_wp_version_too_old() {
147		global $wp_version;
148		return ( ! function_exists( 'rest_api_init' ) \|\| version_compare( $wp_version, '4.4-z', '<=' ) );
149		}
150
151		/**
152		* Checks if REST API is enabled.
153		*
154		* @since 4.4.2
155		*
156		* @return bool
157		*/
158		function is_rest_api_enabled() {
159		return
160		/** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */
161		apply_filters( 'rest_enabled', true ) &&
162		/** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */
163		apply_filters( 'rest_jsonp_enabled', true ) &&
164		/** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */
165		apply_filters( 'rest_authentication_errors', true );
166		}
167
168		/**
169		* Checks the site plan and deactivates modules that were active but are no longer included in the plan.
170		*
171		* @since 4.4.0
172		*
173		* @param $page
174		*
175		* @return bool\|array
176		*/
177		function check_plan_deactivate_modules( $page ) {
178		if (
179		Jetpack::is_development_mode()
180		\|\| ! in_array(
181		$page->base,
182		array(
183		'toplevel_page_jetpack',
184		'admin_page_jetpack_modules',
185		'jetpack_page_vaultpress',
186		'jetpack_page_stats',
187		'jetpack_page_akismet-key-config'
188		)
189		)
190		\|\| true === self::$plan_checked
191		) {
192		return false;
193		}
194
195		self::$plan_checked = true;
196		$previous = get_option( 'jetpack_active_plan', '' );
197		$current = Jetpack_Core_Json_Api_Endpoints::site_data();
198		if ( ! $current \|\| is_wp_error( $current ) ) {
		0 ignored issues – show Bug Best Practice introduced 2017-10-06 20:33 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `$current` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
199		// If we can't get information about the current plan we don't do anything
200		self::$plan_checked = true;
201		return;
202		}
203
204		$to_deactivate = array();
205		if ( isset( $current->plan->product_slug ) ) {
206		if (
207		empty( $previous )
208		\|\| ! isset( $previous['product_slug'] )
209		\|\| $previous['product_slug'] !== $current->plan->product_slug
210		) {
211		$active = Jetpack::get_active_modules();
212		switch ( $current->plan->product_slug ) {
213	View Code Duplication	case 'jetpack_free':
214		$to_deactivate = array( 'seo-tools', 'videopress', 'google-analytics', 'wordads', 'search' );
215		break;
216		case 'jetpack_personal':
217	View Code Duplication	case 'jetpack_personal_monthly':
218		$to_deactivate = array( 'seo-tools', 'videopress', 'google-analytics', 'wordads', 'search' );
219		break;
220		case 'jetpack_premium':
221		case 'jetpack_premium_monthly':
222		$to_deactivate = array( 'seo-tools', 'google-analytics', 'search' );
223		break;
224		}
225		$to_deactivate = array_intersect( $active, $to_deactivate );
226		if ( ! empty( $to_deactivate ) ) {
227		Jetpack::update_active_modules( array_filter( array_diff( $active, $to_deactivate ) ) );
228		}
229		}
230		}
231		return array(
232		'previous' => $previous,
233		'current' => $current,
234		'deactivate' => $to_deactivate
235		);
236		}
237		}
238

Automattic / jetpack

Push — fix/typo-pro-promo ( e5832e...fc698e )

_inc/lib/admin-pages/class.jetpack-admin-page.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like