Jetpack_React_Page::add_page_actions() - Code Metrics - Inspection of "Use blog_id property to be picked up but Tracks ET..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/tracking-for-blogid ( 4748d9...d9697b )

unknown

created 2019-05-08 13:01 UTC

Jetpack_React_Page::add_page_actions() A

↳ Parent: Jetpack_React_Page

Complexity

Conditions	5
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
nc	3
nop	1
dl	0
loc	21
rs	9.2728
c	0
b	0
f	0

<?php
include_once( 'class.jetpack-admin-page.php' );

// Builds the landing page and its menu
class Jetpack_React_Page extends Jetpack_Admin_Page {

	protected $dont_show_if_not_active = false;

	protected $is_redirecting = false;

	function get_page_hook() {
		// Add the main admin Jetpack menu
		return add_menu_page( 'Jetpack', 'Jetpack', 'jetpack_admin_page', 'jetpack', array( $this, 'render' ), 'div' );
	}

	function add_page_actions( $hook ) {
		/** This action is documented in class.jetpack.php */
		do_action( 'jetpack_admin_menu', $hook );

		// Place the Jetpack menu item on top and others in the order they appear
		add_filter( 'custom_menu_order',         '__return_true' );
		add_filter( 'menu_order',                array( $this, 'jetpack_menu_order' ) );

		if ( ! isset( $_GET['page'] ) || 'jetpack' !== $_GET['page'] || ! empty( $_GET['configure'] ) ) {
			return; // No need to handle the fallback redirection if we are not on the Jetpack page
		}

		// Adding a redirect meta tag if the REST API is disabled
		if ( ! $this->is_rest_api_enabled() ) {
			$this->is_redirecting = true;
			add_action( 'admin_head', array( $this, 'add_fallback_head_meta' ) );
		}

		// Adding a redirect meta tag wrapped in noscript tags for all browsers in case they have JavaScript disabled
		add_action( 'admin_head', array( $this, 'add_noscript_head_meta' ) );
	}

	/**
	 * Add Jetpack Dashboard sub-link and point it to AAG if the user can view stats, manage modules or if Protect is active.
	 *
	 * Works in Dev Mode or when user is connected.
	 *
	 * @since 4.3.0
	 */
	function jetpack_add_dashboard_sub_nav_item() {
		if ( Jetpack::is_development_mode() || Jetpack::is_active() ) {
			global $submenu;
			if ( current_user_can( 'jetpack_admin_page' ) ) {
				$submenu['jetpack'][] = array( __( 'Dashboard', 'jetpack' ), 'jetpack_admin_page', 'admin.php?page=jetpack#/dashboard' );
			}
		}
	}

	/**
	 * If user is allowed to see the Jetpack Admin, add Settings sub-link.
	 *
	 * @since 4.3.0
	 */
	function jetpack_add_settings_sub_nav_item() {
		if ( ( Jetpack::is_development_mode() || Jetpack::is_active() ) && current_user_can( 'jetpack_admin_page' ) && current_user_can( 'edit_posts' ) ) {
			global $submenu;
			$submenu['jetpack'][] = array( __( 'Settings', 'jetpack' ), 'jetpack_admin_page', 'admin.php?page=jetpack#/settings' );
		}
	}

	function add_fallback_head_meta() {
		echo '<meta http-equiv="refresh" content="0; url=?page=jetpack_modules">';
	}

	function add_noscript_head_meta() {
		echo '<noscript>';
		$this->add_fallback_head_meta();
		echo '</noscript>';
	}

	function jetpack_menu_order( $menu_order ) {
		$jp_menu_order = array();

		foreach ( $menu_order as $index => $item ) {
			if ( $item != 'jetpack' )
				$jp_menu_order[] = $item;

			if ( $index == 0 )
				$jp_menu_order[] = 'jetpack';
		}

		return $jp_menu_order;
	}

	// Render the configuration page for the module if it exists and an error
	// screen if the module is not configurable
	// @todo remove when real settings are in place
	function render_nojs_configurable( $module_name ) {
		$module_name = preg_replace( '/[^\da-z\-]+/', '', $_GET['configure'] );

		echo '<div class="wrap configure-module">';

		if ( Jetpack::is_module( $module_name ) && current_user_can( 'jetpack_configure_modules' ) ) {
			Jetpack::admin_screen_configure_module( $module_name );
		} else {
			echo '<h2>' . esc_html__( 'Error, bad module.', 'jetpack' ) . '</h2>';
		}

		echo '</div><!-- /wrap -->';
	}

	function page_render() {
		// Handle redirects to configuration pages
		if ( ! empty( $_GET['configure'] ) ) {
			return $this->render_nojs_configurable( $_GET['configure'] );
		}

		/** This action is already documented in views/admin/admin-page.php */
		do_action( 'jetpack_notices' );

		// Try fetching by patch
		$static_html = @file_get_contents( JETPACK__PLUGIN_DIR . '_inc/build/static.html' );

		if ( false === $static_html ) {

			// If we still have nothing, display an error
			echo '<p>';
			esc_html_e( 'Error fetching static.html. Try running: ', 'jetpack' );
			echo '<code>yarn distclean && yarn build</code>';
			echo '</p>';
		} else {

			// We got the static.html so let's display it
			echo $static_html;
		}
	}

	/**
	 * Gets array of any Jetpack notices that have been dismissed.
	 *
	 * @since 4.0.1
	 * @return mixed|void
	 */
	function get_dismissed_jetpack_notices() {
		$jetpack_dismissed_notices = get_option( 'jetpack_dismissed_notices', array() );
		/**
		 * Array of notices that have been dismissed.
		 *
		 * @since 4.0.1
		 *
		 * @param array $jetpack_dismissed_notices If empty, will not show any Jetpack notices.
		 */
		$dismissed_notices = apply_filters( 'jetpack_dismissed_notices', $jetpack_dismissed_notices );
		return $dismissed_notices;
	}

	function additional_styles() {
		Jetpack_Admin_Page::load_wrapper_styles();
	}

	function page_admin_scripts() {
		if ( $this->is_redirecting || isset( $_GET['configure'] ) ) {
			return; // No need for scripts on a fallback page.
		}

		wp_enqueue_script(
			'react-plugin',
			plugins_url( '_inc/build/admin.js', JETPACK__PLUGIN_FILE ),
			array( 'wp-i18n', 'wp-polyfill' ),
			JETPACK__VERSION,
			true
		);

		wp_set_script_translations( 'react-plugin', 'jetpack', JETPACK__PLUGIN_DIR . 'languages/json' );

		if ( ! Jetpack::is_development_mode() && Jetpack::is_active() ) {
			// Required for Analytics.
			wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
		}

		// Add objects to be passed to the initial state of the app.
		wp_localize_script( 'react-plugin', 'Initial_State', $this->get_initial_state() );
	}

	function get_initial_state() {
		// Load API endpoint base classes and endpoints for getting the module list fed into the JS Admin Page
		require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-xmlrpc-consumer-endpoint.php';
		require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-module-endpoints.php';
		$moduleListEndpoint = new Jetpack_Core_API_Module_List_Endpoint();
		$modules = $moduleListEndpoint->get_modules();

		// Preparing translated fields for JSON encoding by transforming all HTML entities to
		// respective characters.
		foreach( $modules as $slug => $data ) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
			$modules[ $slug ]['name'] = html_entity_decode( $data['name'] );
			$modules[ $slug ]['description'] = html_entity_decode( $data['description'] );
			$modules[ $slug ]['short_description'] = html_entity_decode( $data['short_description'] );
			$modules[ $slug ]['long_description'] = html_entity_decode( $data['long_description'] );
		}

		// Collecting roles that can view site stats.
		$stats_roles = array();
		$enabled_roles = function_exists( 'stats_get_option' ) ? stats_get_option( 'roles' ) : array( 'administrator' );

		if ( ! function_exists( 'get_editable_roles' ) ) {
			require_once ABSPATH . 'wp-admin/includes/user.php';
		}
		foreach ( get_editable_roles() as $slug => $role ) {
			$stats_roles[ $slug ] = array(
				'name' => translate_user_role( $role['name'] ),
				'canView' => is_array( $enabled_roles ) ? in_array( $slug, $enabled_roles, true ) : false,
			);
		}

		// Get information about current theme.
		$current_theme = wp_get_theme();

		// Get all themes that Infinite Scroll provides support for natively.
		$inf_scr_support_themes = array();
		foreach ( Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules/infinite-scroll/themes' ) as $path ) {
			if ( is_readable( $path ) ) {
				$inf_scr_support_themes[] = basename( $path, '.php' );
			}
		}

		// Get last post, to build the link to Customizer in the Related Posts module.
		$last_post = get_posts( array( 'posts_per_page' => 1 ) );
		$last_post = isset( $last_post[0] ) && $last_post[0] instanceof WP_Post
if ($x instanceof DoesNotExist) {
    // Do something.
}
			? get_permalink( $last_post[0]->ID )
			: get_home_url();

		// Ensure that class to get the affiliate code is loaded
		if ( ! class_exists( 'Jetpack_Affiliate' ) ) {
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-affiliate.php';
		}

		return array(
			'WP_API_root' => esc_url_raw( rest_url() ),
			'WP_API_nonce' => wp_create_nonce( 'wp_rest' ),
			'pluginBaseUrl' => plugins_url( '', JETPACK__PLUGIN_FILE ),
			'connectionStatus' => array(
				'isActive'  => Jetpack::is_active(),
				'isStaging' => Jetpack::is_staging_site(),
				'devMode'   => array(
					'isActive' => Jetpack::is_development_mode(),
					'constant' => defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG,
					'url'      => site_url() && false === strpos( site_url(), '.' ),
					'filter'   => apply_filters( 'jetpack_development_mode', false ),
				),
				'isPublic'	=> '1' == get_option( 'blog_public' ),
				'isInIdentityCrisis' => Jetpack::validate_sync_error_idc_option(),
				'sandboxDomain' => JETPACK__SANDBOX_DOMAIN,
			),
			'connectUrl' => Jetpack::init()->build_connect_url( true, false, false ),
			'dismissedNotices' => $this->get_dismissed_jetpack_notices(),
			'isDevVersion' => Jetpack::is_development_version(),
			'currentVersion' => JETPACK__VERSION,
			'is_gutenberg_available' => true,
			'getModules' => $modules,
			'showJumpstart' => jetpack_show_jumpstart(),
			'rawUrl' => Jetpack::build_raw_urls( get_home_url() ),
			'adminUrl' => esc_url( admin_url() ),
			'stats' => array(
				// data is populated asynchronously on page load
				'data'  => array(
					'general' => false,
					'day'     => false,
					'week'    => false,
					'month'   => false,
				),
				'roles' => $stats_roles,
			),
			'aff' => Jetpack_Affiliate::init()->get_affiliate_code(),
			'settings' => $this->get_flattened_settings( $modules ),
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
			'userData' => array(
//				'othersLinked' => Jetpack::get_other_linked_admins(),
				'currentUser'  => jetpack_current_user_data(),
			),
			'siteData' => array(
				'icon' => has_site_icon()
					? apply_filters( 'jetpack_photon_url', get_site_icon_url(), array( 'w' => 64 ) )
					: '',
				'siteVisibleToSearchEngines' => '1' == get_option( 'blog_public' ),
				/**
				 * Whether promotions are visible or not.
				 *
				 * @since 4.8.0
				 *
				 * @param bool $are_promotions_active Status of promotions visibility. True by default.
				 */
				'showPromotions' => apply_filters( 'jetpack_show_promotions', true ),
				'isAtomicSite' => jetpack_is_atomic_site(),
				'plan' => Jetpack_Plan::get(),
				'showBackups' => Jetpack::show_backups_ui(),
			),
			'themeData' => array(
				'name'      => $current_theme->get( 'Name' ),
				'hasUpdate' => (bool) get_theme_update_available( $current_theme ),
				'support'   => array(
					'infinite-scroll' => current_theme_supports( 'infinite-scroll' ) || in_array( $current_theme->get_stylesheet(), $inf_scr_support_themes ),
				),
			),
			'locale' => Jetpack::get_i18n_data_json(),
			'localeSlug' => join( '-', explode( '_', get_user_locale() ) ),
			'jetpackStateNotices' => array(
				'messageCode' => Jetpack::state( 'message' ),
				'errorCode' => Jetpack::state( 'error' ),
				'errorDescription' => Jetpack::state( 'error_description' ),
			),
			'tracksUserData' => Jetpack_Tracks_Client::get_connected_user_tracks_identity(),
			'currentIp' => function_exists( 'jetpack_protect_get_ip' ) ? jetpack_protect_get_ip() : false,
			'lastPostUrl' => esc_url( $last_post ),
			'externalServicesConnectUrls' => $this->get_external_services_connect_urls()
		);
	}

	function get_external_services_connect_urls() {
		$connect_urls = array();
		jetpack_require_lib( 'class.jetpack-keyring-service-helper' );
		foreach ( Jetpack_Keyring_Service_Helper::$SERVICES as $service_name => $service_info ) {
			$connect_urls[ $service_name ] = Jetpack_Keyring_Service_Helper::connect_url( $service_name, $service_info[ 'for' ] );
		}
		return $connect_urls;
	}

	/**
	 * Returns an array of modules and settings both as first class members of the object.
	 *
	 * @param array $modules the result of an API request to get all modules.
	 *
	 * @return array flattened settings with modules.
	 */
	function get_flattened_settings( $modules ) {
		$core_api_endpoint = new Jetpack_Core_API_Data();
		$settings = $core_api_endpoint->get_all_options();
		return $settings->data;
	}
}

/*
 * Only show Jump Start on first activation.
 * Any option 'jumpstart' other than 'new connection' will hide it.
 *
 * The option can be of 4 things, and will be stored as such:
 * new_connection      : Brand new connection - Show
 * jumpstart_activated : Jump Start has been activated - dismiss
 * jetpack_action_taken: Manual activation of a module already happened - dismiss
 * jumpstart_dismissed : Manual dismissal of Jump Start - dismiss
 *
 * @todo move to functions.global.php when available
 * @since 3.6
 * @return bool | show or hide
 */
function jetpack_show_jumpstart() {
	if ( ! Jetpack::is_active() ) {
		return false;
	}
	$jumpstart_option = Jetpack_Options::get_option( 'jumpstart' );

	$hide_options = array(
		'jumpstart_activated',
		'jetpack_action_taken',
		'jumpstart_dismissed'
	);

	if ( ! $jumpstart_option || in_array( $jumpstart_option, $hide_options ) ) {
		return false;
	}

	return true;
}

/**
 * Gather data about the current user.
 *
 * @since 4.1.0
 *
 * @return array
 */
function jetpack_current_user_data() {
	$current_user = wp_get_current_user();
	$is_master_user = $current_user->ID == Jetpack_Options::get_option( 'master_user' );
	$dotcom_data    = Jetpack::get_connected_user_data();
	// Add connected user gravatar to the returned dotcom_data.
	$dotcom_data['avatar'] = get_avatar_url( $dotcom_data['email'], array( 'size' => 64, 'default' => 'mysteryman' ) );

	$current_user_data = array(
		'isConnected' => Jetpack::is_user_connected( $current_user->ID ),
		'isMaster'    => $is_master_user,
		'username'    => $current_user->user_login,
		'id'          => $current_user->ID,
		'wpcomUser'   => $dotcom_data,
		'gravatar'    => get_avatar( $current_user->ID, 40, 'mm', '', array( 'force_display' => true ) ),
		'permissions' => array(
			'admin_page'         => current_user_can( 'jetpack_admin_page' ),
			'connect'            => current_user_can( 'jetpack_connect' ),
			'disconnect'         => current_user_can( 'jetpack_disconnect' ),
			'manage_modules'     => current_user_can( 'jetpack_manage_modules' ),
			'network_admin'      => current_user_can( 'jetpack_network_admin_page' ),
			'network_sites_page' => current_user_can( 'jetpack_network_sites_page' ),
			'edit_posts'         => current_user_can( 'edit_posts' ),
			'publish_posts'      => current_user_can( 'publish_posts' ),
			'manage_options'     => current_user_can( 'manage_options' ),
			'view_stats'		 => current_user_can( 'view_stats' ),
			'manage_plugins'	 => current_user_can( 'install_plugins' )
									&& current_user_can( 'activate_plugins' )
									&& current_user_can( 'update_plugins' )
									&& current_user_can( 'delete_plugins' ),
		),
	);

	return $current_user_data;
}


Push — add/tracking-for-blogid ( 4748d9...d9697b )

Jetpack_React_Page::add_page_actions() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1		<?php
2		include_once( 'class.jetpack-admin-page.php' );
3
4		// Builds the landing page and its menu
5		class Jetpack_React_Page extends Jetpack_Admin_Page {
6
7		protected $dont_show_if_not_active = false;
8
9		protected $is_redirecting = false;
10
11		function get_page_hook() {
12		// Add the main admin Jetpack menu
13		return add_menu_page( 'Jetpack', 'Jetpack', 'jetpack_admin_page', 'jetpack', array( $this, 'render' ), 'div' );
14		}
15
16		function add_page_actions( $hook ) {
17		/** This action is documented in class.jetpack.php */
18		do_action( 'jetpack_admin_menu', $hook );
19
20		// Place the Jetpack menu item on top and others in the order they appear
21		add_filter( 'custom_menu_order', '__return_true' );
22		add_filter( 'menu_order', array( $this, 'jetpack_menu_order' ) );
23
24		if ( ! isset( $_GET['page'] ) \|\| 'jetpack' !== $_GET['page'] \|\| ! empty( $_GET['configure'] ) ) {
25		return; // No need to handle the fallback redirection if we are not on the Jetpack page
26		}
27
28		// Adding a redirect meta tag if the REST API is disabled
29		if ( ! $this->is_rest_api_enabled() ) {
30		$this->is_redirecting = true;
31		add_action( 'admin_head', array( $this, 'add_fallback_head_meta' ) );
32		}
33
34		// Adding a redirect meta tag wrapped in noscript tags for all browsers in case they have JavaScript disabled
35		add_action( 'admin_head', array( $this, 'add_noscript_head_meta' ) );
36		}
37
38		/**
39		* Add Jetpack Dashboard sub-link and point it to AAG if the user can view stats, manage modules or if Protect is active.
40		*
41		* Works in Dev Mode or when user is connected.
42		*
43		* @since 4.3.0
44		*/
45		function jetpack_add_dashboard_sub_nav_item() {
46	View Code Duplication	if ( Jetpack::is_development_mode() \|\| Jetpack::is_active() ) {
47		global $submenu;
48		if ( current_user_can( 'jetpack_admin_page' ) ) {
49		$submenu['jetpack'][] = array( __( 'Dashboard', 'jetpack' ), 'jetpack_admin_page', 'admin.php?page=jetpack#/dashboard' );
50		}
51		}
52		}
53
54		/**
55		* If user is allowed to see the Jetpack Admin, add Settings sub-link.
56		*
57		* @since 4.3.0
58		*/
59		function jetpack_add_settings_sub_nav_item() {
60	View Code Duplication	if ( ( Jetpack::is_development_mode() \|\| Jetpack::is_active() ) && current_user_can( 'jetpack_admin_page' ) && current_user_can( 'edit_posts' ) ) {
61		global $submenu;
62		$submenu['jetpack'][] = array( __( 'Settings', 'jetpack' ), 'jetpack_admin_page', 'admin.php?page=jetpack#/settings' );
63		}
64		}
65
66		function add_fallback_head_meta() {
67		echo '<meta http-equiv="refresh" content="0; url=?page=jetpack_modules">';
68		}
69
70		function add_noscript_head_meta() {
71		echo '<noscript>';
72		$this->add_fallback_head_meta();
73		echo '</noscript>';
74		}
75
76	View Code Duplication	function jetpack_menu_order( $menu_order ) {
77		$jp_menu_order = array();
78
79		foreach ( $menu_order as $index => $item ) {
80		if ( $item != 'jetpack' )
81		$jp_menu_order[] = $item;
82
83		if ( $index == 0 )
84		$jp_menu_order[] = 'jetpack';
85		}
86
87		return $jp_menu_order;
88		}
89
90		// Render the configuration page for the module if it exists and an error
91		// screen if the module is not configurable
92		// @todo remove when real settings are in place
93		function render_nojs_configurable( $module_name ) {
94		$module_name = preg_replace( '/[^\da-z\-]+/', '', $_GET['configure'] );
95
96		echo '<div class="wrap configure-module">';
97
98		if ( Jetpack::is_module( $module_name ) && current_user_can( 'jetpack_configure_modules' ) ) {
99		Jetpack::admin_screen_configure_module( $module_name );
100		} else {
101		echo '<h2>' . esc_html__( 'Error, bad module.', 'jetpack' ) . '</h2>';
102		}
103
104		echo '</div><!-- /wrap -->';
105		}
106
107		function page_render() {
108		// Handle redirects to configuration pages
109		if ( ! empty( $_GET['configure'] ) ) {
110		return $this->render_nojs_configurable( $_GET['configure'] );
111		}
112
113		/** This action is already documented in views/admin/admin-page.php */
114		do_action( 'jetpack_notices' );
115
116		// Try fetching by patch
117		$static_html = @file_get_contents( JETPACK__PLUGIN_DIR . '_inc/build/static.html' );
118
119		if ( false === $static_html ) {
120
121		// If we still have nothing, display an error
122		echo '<p>';
123		esc_html_e( 'Error fetching static.html. Try running: ', 'jetpack' );
124		echo '<code>yarn distclean && yarn build</code>';
125		echo '</p>';
126		} else {
127
128		// We got the static.html so let's display it
129		echo $static_html;
130		}
131		}
132
133		/**
134		* Gets array of any Jetpack notices that have been dismissed.
135		*
136		* @since 4.0.1
137		* @return mixed\|void
138		*/
139		function get_dismissed_jetpack_notices() {
140		$jetpack_dismissed_notices = get_option( 'jetpack_dismissed_notices', array() );
141		/**
142		* Array of notices that have been dismissed.
143		*
144		* @since 4.0.1
145		*
146		* @param array $jetpack_dismissed_notices If empty, will not show any Jetpack notices.
147		*/
148		$dismissed_notices = apply_filters( 'jetpack_dismissed_notices', $jetpack_dismissed_notices );
149		return $dismissed_notices;
150		}
151
152		function additional_styles() {
153		Jetpack_Admin_Page::load_wrapper_styles();
154		}
155
156		function page_admin_scripts() {
157		if ( $this->is_redirecting \|\| isset( $_GET['configure'] ) ) {
158		return; // No need for scripts on a fallback page.
159		}
160
161		wp_enqueue_script(
162		'react-plugin',
163		plugins_url( '_inc/build/admin.js', JETPACK__PLUGIN_FILE ),
164		array( 'wp-i18n', 'wp-polyfill' ),
165		JETPACK__VERSION,
166		true
167		);
168
169		wp_set_script_translations( 'react-plugin', 'jetpack', JETPACK__PLUGIN_DIR . 'languages/json' );
170
171		if ( ! Jetpack::is_development_mode() && Jetpack::is_active() ) {
172		// Required for Analytics.
173		wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
174		}
175
176		// Add objects to be passed to the initial state of the app.
177		wp_localize_script( 'react-plugin', 'Initial_State', $this->get_initial_state() );
178		}
179
180		function get_initial_state() {
181		// Load API endpoint base classes and endpoints for getting the module list fed into the JS Admin Page
182		require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-xmlrpc-consumer-endpoint.php';
183		require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-module-endpoints.php';
184		$moduleListEndpoint = new Jetpack_Core_API_Module_List_Endpoint();
185		$modules = $moduleListEndpoint->get_modules();
186
187		// Preparing translated fields for JSON encoding by transforming all HTML entities to
188		// respective characters.
189		foreach( $modules as $slug => $data ) {
		0 ignored issues – show Bug introduced 2017-10-06 18:49 UTC by Report Bug Copy Issue Report The expression `$modules` of type `string\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
190		$modules[ $slug ]['name'] = html_entity_decode( $data['name'] );
191		$modules[ $slug ]['description'] = html_entity_decode( $data['description'] );
192		$modules[ $slug ]['short_description'] = html_entity_decode( $data['short_description'] );
193		$modules[ $slug ]['long_description'] = html_entity_decode( $data['long_description'] );
194		}
195
196		// Collecting roles that can view site stats.
197		$stats_roles = array();
198		$enabled_roles = function_exists( 'stats_get_option' ) ? stats_get_option( 'roles' ) : array( 'administrator' );
199
200		if ( ! function_exists( 'get_editable_roles' ) ) {
201		require_once ABSPATH . 'wp-admin/includes/user.php';
202		}
203		foreach ( get_editable_roles() as $slug => $role ) {
204		$stats_roles[ $slug ] = array(
205		'name' => translate_user_role( $role['name'] ),
206		'canView' => is_array( $enabled_roles ) ? in_array( $slug, $enabled_roles, true ) : false,
207		);
208		}
209
210		// Get information about current theme.
211		$current_theme = wp_get_theme();
212
213		// Get all themes that Infinite Scroll provides support for natively.
214		$inf_scr_support_themes = array();
215		foreach ( Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules/infinite-scroll/themes' ) as $path ) {
216		if ( is_readable( $path ) ) {
217		$inf_scr_support_themes[] = basename( $path, '.php' );
218		}
219		}
220
221		// Get last post, to build the link to Customizer in the Related Posts module.
222		$last_post = get_posts( array( 'posts_per_page' => 1 ) );
223		$last_post = isset( $last_post[0] ) && $last_post[0] instanceof WP_Post
		0 ignored issues – show Bug introduced 2016-09-19 18:57 UTC by Report Bug Copy Issue Report The class `WP_Post` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
224		? get_permalink( $last_post[0]->ID )
225		: get_home_url();
226
227		// Ensure that class to get the affiliate code is loaded
228		if ( ! class_exists( 'Jetpack_Affiliate' ) ) {
229		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-affiliate.php';
230		}
231
232		return array(
233		'WP_API_root' => esc_url_raw( rest_url() ),
234		'WP_API_nonce' => wp_create_nonce( 'wp_rest' ),
235		'pluginBaseUrl' => plugins_url( '', JETPACK__PLUGIN_FILE ),
236		'connectionStatus' => array(
237		'isActive' => Jetpack::is_active(),
238		'isStaging' => Jetpack::is_staging_site(),
239		'devMode' => array(
240		'isActive' => Jetpack::is_development_mode(),
241		'constant' => defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG,
242		'url' => site_url() && false === strpos( site_url(), '.' ),
243		'filter' => apply_filters( 'jetpack_development_mode', false ),
244		),
245		'isPublic' => '1' == get_option( 'blog_public' ),
246		'isInIdentityCrisis' => Jetpack::validate_sync_error_idc_option(),
247		'sandboxDomain' => JETPACK__SANDBOX_DOMAIN,
248		),
249		'connectUrl' => Jetpack::init()->build_connect_url( true, false, false ),
250		'dismissedNotices' => $this->get_dismissed_jetpack_notices(),
251		'isDevVersion' => Jetpack::is_development_version(),
252		'currentVersion' => JETPACK__VERSION,
253		'is_gutenberg_available' => true,
254		'getModules' => $modules,
255		'showJumpstart' => jetpack_show_jumpstart(),
256		'rawUrl' => Jetpack::build_raw_urls( get_home_url() ),
257		'adminUrl' => esc_url( admin_url() ),
258		'stats' => array(
259		// data is populated asynchronously on page load
260		'data' => array(
261		'general' => false,
262		'day' => false,
263		'week' => false,
264		'month' => false,
265		),
266		'roles' => $stats_roles,
267		),
268		'aff' => Jetpack_Affiliate::init()->get_affiliate_code(),
269		'settings' => $this->get_flattened_settings( $modules ),
		0 ignored issues – show Bug introduced 2017-10-06 18:49 UTC by Report Bug Copy Issue Report It seems like `$modules` defined by `$moduleListEndpoint->get_modules()` on line `185` can also be of type `string`; however, `Jetpack_React_Page::get_flattened_settings()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
270		'userData' => array(
271		// 'othersLinked' => Jetpack::get_other_linked_admins(),
272		'currentUser' => jetpack_current_user_data(),
273		),
274		'siteData' => array(
275		'icon' => has_site_icon()
276		? apply_filters( 'jetpack_photon_url', get_site_icon_url(), array( 'w' => 64 ) )
277		: '',
278		'siteVisibleToSearchEngines' => '1' == get_option( 'blog_public' ),
279		/**
280		* Whether promotions are visible or not.
281		*
282		* @since 4.8.0
283		*
284		* @param bool $are_promotions_active Status of promotions visibility. True by default.
285		*/
286		'showPromotions' => apply_filters( 'jetpack_show_promotions', true ),
287		'isAtomicSite' => jetpack_is_atomic_site(),
288		'plan' => Jetpack_Plan::get(),
289		'showBackups' => Jetpack::show_backups_ui(),
290		),
291		'themeData' => array(
292		'name' => $current_theme->get( 'Name' ),
293		'hasUpdate' => (bool) get_theme_update_available( $current_theme ),
294		'support' => array(
295		'infinite-scroll' => current_theme_supports( 'infinite-scroll' ) \|\| in_array( $current_theme->get_stylesheet(), $inf_scr_support_themes ),
296		),
297		),
298		'locale' => Jetpack::get_i18n_data_json(),
299		'localeSlug' => join( '-', explode( '_', get_user_locale() ) ),
300		'jetpackStateNotices' => array(
301		'messageCode' => Jetpack::state( 'message' ),
302		'errorCode' => Jetpack::state( 'error' ),
303		'errorDescription' => Jetpack::state( 'error_description' ),
304		),
305		'tracksUserData' => Jetpack_Tracks_Client::get_connected_user_tracks_identity(),
306		'currentIp' => function_exists( 'jetpack_protect_get_ip' ) ? jetpack_protect_get_ip() : false,
307		'lastPostUrl' => esc_url( $last_post ),
308		'externalServicesConnectUrls' => $this->get_external_services_connect_urls()
309		);
310		}
311
312		function get_external_services_connect_urls() {
313		$connect_urls = array();
314		jetpack_require_lib( 'class.jetpack-keyring-service-helper' );
315		foreach ( Jetpack_Keyring_Service_Helper::$SERVICES as $service_name => $service_info ) {
316		$connect_urls[ $service_name ] = Jetpack_Keyring_Service_Helper::connect_url( $service_name, $service_info[ 'for' ] );
317		}
318		return $connect_urls;
319		}
320
321		/**
322		* Returns an array of modules and settings both as first class members of the object.
323		*
324		* @param array $modules the result of an API request to get all modules.
325		*
326		* @return array flattened settings with modules.
327		*/
328		function get_flattened_settings( $modules ) {
329		$core_api_endpoint = new Jetpack_Core_API_Data();
330		$settings = $core_api_endpoint->get_all_options();
331		return $settings->data;
332		}
333		}
334
335		/*
336		* Only show Jump Start on first activation.
337		* Any option 'jumpstart' other than 'new connection' will hide it.
338		*
339		* The option can be of 4 things, and will be stored as such:
340		* new_connection : Brand new connection - Show
341		* jumpstart_activated : Jump Start has been activated - dismiss
342		* jetpack_action_taken: Manual activation of a module already happened - dismiss
343		* jumpstart_dismissed : Manual dismissal of Jump Start - dismiss
344		*
345		* @todo move to functions.global.php when available
346		* @since 3.6
347		* @return bool \| show or hide
348		*/
349		function jetpack_show_jumpstart() {
350		if ( ! Jetpack::is_active() ) {
351		return false;
352		}
353		$jumpstart_option = Jetpack_Options::get_option( 'jumpstart' );
354
355		$hide_options = array(
356		'jumpstart_activated',
357		'jetpack_action_taken',
358		'jumpstart_dismissed'
359		);
360
361		if ( ! $jumpstart_option \|\| in_array( $jumpstart_option, $hide_options ) ) {
362		return false;
363		}
364
365		return true;
366		}
367
368		/**
369		* Gather data about the current user.
370		*
371		* @since 4.1.0
372		*
373		* @return array
374		*/
375		function jetpack_current_user_data() {
376		$current_user = wp_get_current_user();
377		$is_master_user = $current_user->ID == Jetpack_Options::get_option( 'master_user' );
378		$dotcom_data = Jetpack::get_connected_user_data();
379		// Add connected user gravatar to the returned dotcom_data.
380		$dotcom_data['avatar'] = get_avatar_url( $dotcom_data['email'], array( 'size' => 64, 'default' => 'mysteryman' ) );
381
382		$current_user_data = array(
383		'isConnected' => Jetpack::is_user_connected( $current_user->ID ),
384		'isMaster' => $is_master_user,
385		'username' => $current_user->user_login,
386		'id' => $current_user->ID,
387		'wpcomUser' => $dotcom_data,
388		'gravatar' => get_avatar( $current_user->ID, 40, 'mm', '', array( 'force_display' => true ) ),
389		'permissions' => array(
390		'admin_page' => current_user_can( 'jetpack_admin_page' ),
391		'connect' => current_user_can( 'jetpack_connect' ),
392		'disconnect' => current_user_can( 'jetpack_disconnect' ),
393		'manage_modules' => current_user_can( 'jetpack_manage_modules' ),
394		'network_admin' => current_user_can( 'jetpack_network_admin_page' ),
395		'network_sites_page' => current_user_can( 'jetpack_network_sites_page' ),
396		'edit_posts' => current_user_can( 'edit_posts' ),
397		'publish_posts' => current_user_can( 'publish_posts' ),
398		'manage_options' => current_user_can( 'manage_options' ),
399		'view_stats' => current_user_can( 'view_stats' ),
400		'manage_plugins' => current_user_can( 'install_plugins' )
401		&& current_user_can( 'activate_plugins' )
402		&& current_user_can( 'update_plugins' )
403		&& current_user_can( 'delete_plugins' ),
404		),
405		);
406
407		return $current_user_data;
408		}
409

Automattic / jetpack

Push — add/tracking-for-blogid ( 4748d9...d9697b )

Jetpack_React_Page::add_page_actions() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like