Inspection of "Merge branch 'master' of github.com:Automattic/jet..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — e2e-separate-node-project ( a4d8ee...3e87c6 )

unknown

created 2021-02-16 10:47 UTC

Status

Doc Comments +36 added lines, -17 removed lines patch added patch discarded remove patch

@@ -956,7 +956,7 @@  discard block
 block discarded – undo
 	 * This is ported over from the manage module, which has been deprecated and baked in here.
 	 *
 	 * @param $domains
-	 * @return array
+	 * @return string[]
 	 */
 	function allow_wpcom_domain( $domains ) {
 		if ( empty( $domains ) ) {
@@ -1324,7 +1324,7 @@  discard block
 block discarded – undo
 	/**
 	 * Does the network allow admins to add new users.
 	 *
-	 * @return boolian
+	 * @return boolean
 	 */
 	static function network_add_new_users( $option = null ) {
 		return (bool) get_site_option( 'add_new_users' );
@@ -1434,7 +1434,7 @@  discard block
 block discarded – undo
 	 *
 	 * @param  bool $option
 	 *
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_main_network_option( $option ) {
 		// return '1' or ''
@@ -1445,7 +1445,7 @@  discard block
 block discarded – undo
 	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
 	 *
 	 * @param  string $option
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_multisite( $option ) {
 		return (string) (bool) is_multisite();
@@ -1508,7 +1508,7 @@  discard block
 block discarded – undo
 	/**
 	 * Returns true if the site has file write access false otherwise.
 	 *
-	 * @return string ( '1' | '0' )
+	 * @return integer ( '1' | '0' )
 	 **/
 	public static function file_system_write_access() {
 		if ( ! function_exists( 'get_filesystem_method' ) ) {
@@ -2237,7 +2237,7 @@  discard block
 block discarded – undo
 	 * @param int    $user_id The user id.
 	 * @param string $token The user token.
 	 * @param bool   $is_master_user Whether the user is the master user.
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public static function update_user_token( $user_id, $token, $is_master_user ) {
 		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
@@ -2681,7 +2681,7 @@  discard block
 block discarded – undo
 	 *
 	 * @param string $tag Tag as it appears in each module heading.
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public static function translate_module_tag( $tag ) {
 		return jetpack_get_module_i18n_tag( $tag );
@@ -2796,8 +2796,8 @@  discard block
 block discarded – undo
 	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
 	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
 	 *
-	 * @param $string
-	 * @return mixed
+	 * @param string $string
+	 * @return string|null
 	 */
 	public static function alias_directories( $string ) {
 		// ABSPATH has a trailing slash.
@@ -2808,6 +2808,10 @@  discard block
 block discarded – undo
 		return $string;
 	}
 
+	/**
+	 * @param boolean $redirect
+	 * @param boolean $send_state_messages
+	 */
 	public static function activate_default_modules(
 		$min_version = false,
 		$max_version = false,
@@ -3091,6 +3095,9 @@  discard block
 block discarded – undo
 		return self::update_active_modules( $new );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function enable_module_configurable( $module ) {
 		$module = self::get_module_slug( $module );
 		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
@@ -3119,6 +3126,10 @@  discard block
 block discarded – undo
 	}
 
 	/* Installation */
+
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 		?>
 <!doctype html>
@@ -3164,6 +3175,7 @@  discard block
 block discarded – undo
 	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
 	 *
 	 * @static
+	 * @param boolean $network_wide
 	 */
 	public static function plugin_activation( $network_wide ) {
 		Jetpack_Options::update_option( 'activated', 1 );
@@ -3884,7 +3896,7 @@  discard block
 block discarded – undo
 	 * Add help to the Jetpack page
 	 *
 	 * @since Jetpack (1.2.3)
-	 * @return false if not the Jetpack page
+	 * @return false|null if not the Jetpack page
 	 */
 	function admin_help() {
 		$current_screen = get_current_screen();
@@ -4588,6 +4600,7 @@  discard block
 block discarded – undo
 
 	/**
 	 * Record a stat for later output.  This will only currently output in the admin_footer.
+	 * @param string $group
 	 */
 	function stat( $group, $detail ) {
 		$this->initialize_stats();
@@ -5001,6 +5014,9 @@  discard block
 block discarded – undo
 		return $url;
 	}
 
+	/**
+	 * @param string $actionurl
+	 */
 	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
 		$actionurl = str_replace( '&amp;', '&', $actionurl );
 		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
@@ -5291,12 +5307,15 @@  discard block
 block discarded – undo
 	 * @param String  $action  The action name.
 	 * @param Integer $user_id The user identifier.
 	 * @param Integer $exp     Expiration time in seconds.
-	 * @return array
+	 * @return boolean
 	 */
 	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
 		return self::connection()->generate_secrets( $action, $user_id, $exp );
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public static function get_secrets( $action, $user_id ) {
 		$secrets = self::connection()->get_secrets( $action, $user_id );
 
@@ -5547,7 +5566,6 @@  discard block
 block discarded – undo
 	 * @deprecated since 8.9.0
 	 * @see Automattic\Jetpack\Connection\Rest_Authentication::wp_rest_authentication_errors()
 	 *
-	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
 	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
 	 */
 	public function wp_rest_authentication_errors( $value ) {
@@ -5640,6 +5658,7 @@  discard block
 block discarded – undo
 	 * @param string $key
 	 * @param string $value
 	 * @param bool   $restate private
+	 * @return string
 	 */
 	public static function state( $key = null, $value = null, $restate = false ) {
 		static $state = array();
@@ -5721,6 +5740,9 @@  discard block
 block discarded – undo
 		return true;
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -6293,9 +6315,7 @@  discard block
 block discarded – undo
 	 *
 	 * Attached to `style_loader_src` filter.
 	 *
-	 * @param string $tag The tag that would link to the external asset.
 	 * @param string $handle The registered handle of the script in question.
-	 * @param string $href The url of the asset in question.
 	 */
 	public static function set_suffix_on_min( $src, $handle ) {
 		if ( false === strpos( $src, '.min.css' ) ) {
@@ -6671,8 +6691,8 @@  discard block
 block discarded – undo
 	 *  - Absolute URLs             `http://domain.com/feh.png`
 	 *  - Domain root relative URLs `/feh.png`
 	 *
-	 * @param $css string: The raw CSS -- should be read in directly from the file.
-	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
+	 * @param string $css string: The raw CSS -- should be read in directly from the file.
+	 * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from.
 	 *
 	 * @return mixed|string
 	 */
@@ -6971,7 +6991,6 @@  discard block
 block discarded – undo
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {

Please login to merge, or discard this patch.

_inc/subscription-service/class-token-subscription-service.php 1 patch

Doc Comments +1 added lines, -1 removed lines patch added patch discarded remove patch

@@ -149,7 +149,7 @@
 block discarded – undo
 	/**
 	 * Get the token stored in the auth cookie.
 	 *
-	 * @return ?string
+	 * @return string
 	 */
 	private function token_from_cookie() {
 		if ( isset( $_COOKIE[ self::JWT_AUTH_TOKEN_COOKIE_NAME ] ) ) {

Please login to merge, or discard this patch.

		@@ -956,7 +956,7 @@ discard block
		block discarded – undo
956	956	* This is ported over from the manage module, which has been deprecated and baked in here.
957	957	*
958	958	* @param $domains
959		- * @return array
	959	+ * @return string[]
960	960	*/
961	961	function allow_wpcom_domain( $domains ) {
962	962	if ( empty( $domains ) ) {
		@@ -1324,7 +1324,7 @@ discard block
		block discarded – undo
1324	1324	/**
1325	1325	* Does the network allow admins to add new users.
1326	1326	*
1327		- * @return boolian
	1327	+ * @return boolean
1328	1328	*/
1329	1329	static function network_add_new_users( $option = null ) {
1330	1330	return (bool) get_site_option( 'add_new_users' );
		@@ -1434,7 +1434,7 @@ discard block
		block discarded – undo
1434	1434	*
1435	1435	* @param bool $option
1436	1436	*
1437		- * @return boolean
	1437	+ * @return string
1438	1438	*/
1439	1439	public function is_main_network_option( $option ) {
1440	1440	// return '1' or ''
		@@ -1445,7 +1445,7 @@ discard block
		block discarded – undo
1445	1445	* Return true if we are with multi-site or multi-network false if we are dealing with single site.
1446	1446	*
1447	1447	* @param string $option
1448		- * @return boolean
	1448	+ * @return string
1449	1449	*/
1450	1450	public function is_multisite( $option ) {
1451	1451	return (string) (bool) is_multisite();
		@@ -1508,7 +1508,7 @@ discard block
		block discarded – undo
1508	1508	/**
1509	1509	* Returns true if the site has file write access false otherwise.
1510	1510	*
1511		- * @return string ( '1' \| '0' )
	1511	+ * @return integer ( '1' \| '0' )
1512	1512	**/
1513	1513	public static function file_system_write_access() {
1514	1514	if ( ! function_exists( 'get_filesystem_method' ) ) {
		@@ -2237,7 +2237,7 @@ discard block
		block discarded – undo
2237	2237	* @param int $user_id The user id.
2238	2238	* @param string $token The user token.
2239	2239	* @param bool $is_master_user Whether the user is the master user.
2240		- * @return bool
	2240	+ * @return boolean\|null
2241	2241	*/
2242	2242	public static function update_user_token( $user_id, $token, $is_master_user ) {
2243	2243	_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
		@@ -2681,7 +2681,7 @@ discard block
		block discarded – undo
2681	2681	*
2682	2682	* @param string $tag Tag as it appears in each module heading.
2683	2683	*
2684		- * @return mixed
	2684	+ * @return string
2685	2685	*/
2686	2686	public static function translate_module_tag( $tag ) {
2687	2687	return jetpack_get_module_i18n_tag( $tag );
		@@ -2796,8 +2796,8 @@ discard block
		block discarded – undo
2796	2796	* Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2797	2797	* is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2798	2798	*
2799		- * @param $string
2800		- * @return mixed
	2799	+ * @param string $string
	2800	+ * @return string\|null
2801	2801	*/
2802	2802	public static function alias_directories( $string ) {
2803	2803	// ABSPATH has a trailing slash.
		@@ -2808,6 +2808,10 @@ discard block
		block discarded – undo
2808	2808	return $string;
2809	2809	}
2810	2810
	2811	+ /**
	2812	+ * @param boolean $redirect
	2813	+ * @param boolean $send_state_messages
	2814	+ */
2811	2815	public static function activate_default_modules(
2812	2816	$min_version = false,
2813	2817	$max_version = false,
		@@ -3091,6 +3095,9 @@ discard block
		block discarded – undo
3091	3095	return self::update_active_modules( $new );
3092	3096	}
3093	3097
	3098	+ /**
	3099	+ * @param string $module
	3100	+ */
3094	3101	public static function enable_module_configurable( $module ) {
3095	3102	$module = self::get_module_slug( $module );
3096	3103	add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
		@@ -3119,6 +3126,10 @@ discard block
		block discarded – undo
3119	3126	}
3120	3127
3121	3128	/* Installation */
	3129	+
	3130	+ /**
	3131	+ * @param string $message
	3132	+ */
3122	3133	public static function bail_on_activation( $message, $deactivate = true ) {
3123	3134	?>
3124	3135	<!doctype html>
		@@ -3164,6 +3175,7 @@ discard block
		block discarded – undo
3164	3175	* Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3165	3176	*
3166	3177	* @static
	3178	+ * @param boolean $network_wide
3167	3179	*/
3168	3180	public static function plugin_activation( $network_wide ) {
3169	3181	Jetpack_Options::update_option( 'activated', 1 );
		@@ -3884,7 +3896,7 @@ discard block
		block discarded – undo
3884	3896	* Add help to the Jetpack page
3885	3897	*
3886	3898	* @since Jetpack (1.2.3)
3887		- * @return false if not the Jetpack page
	3899	+ * @return false\|null if not the Jetpack page
3888	3900	*/
3889	3901	function admin_help() {
3890	3902	$current_screen = get_current_screen();
		@@ -4588,6 +4600,7 @@ discard block
		block discarded – undo
4588	4600
4589	4601	/**
4590	4602	* Record a stat for later output. This will only currently output in the admin_footer.
	4603	+ * @param string $group
4591	4604	*/
4592	4605	function stat( $group, $detail ) {
4593	4606	$this->initialize_stats();
		@@ -5001,6 +5014,9 @@ discard block
		block discarded – undo
5001	5014	return $url;
5002	5015	}
5003	5016
	5017	+ /**
	5018	+ * @param string $actionurl
	5019	+ */
5004	5020	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
5005	5021	$actionurl = str_replace( '&', '&', $actionurl );
5006	5022	return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
		@@ -5291,12 +5307,15 @@ discard block
		block discarded – undo
5291	5307	* @param String $action The action name.
5292	5308	* @param Integer $user_id The user identifier.
5293	5309	* @param Integer $exp Expiration time in seconds.
5294		- * @return array
	5310	+ * @return boolean
5295	5311	*/
5296	5312	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5297	5313	return self::connection()->generate_secrets( $action, $user_id, $exp );
5298	5314	}
5299	5315
	5316	+ /**
	5317	+ * @param string $action
	5318	+ */
5300	5319	public static function get_secrets( $action, $user_id ) {
5301	5320	$secrets = self::connection()->get_secrets( $action, $user_id );
5302	5321
		@@ -5547,7 +5566,6 @@ discard block
		block discarded – undo
5547	5566	* @deprecated since 8.9.0
5548	5567	* @see Automattic\Jetpack\Connection\Rest_Authentication::wp_rest_authentication_errors()
5549	5568	*
5550		- * @param WP_Error\|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
5551	5569	* @return WP_Error\|boolean\|null {@see WP_JSON_Server::check_authentication}
5552	5570	*/
5553	5571	public function wp_rest_authentication_errors( $value ) {
		@@ -5640,6 +5658,7 @@ discard block
		block discarded – undo
5640	5658	* @param string $key
5641	5659	* @param string $value
5642	5660	* @param bool $restate private
	5661	+ * @return string
5643	5662	*/
5644	5663	public static function state( $key = null, $value = null, $restate = false ) {
5645	5664	static $state = array();
		@@ -5721,6 +5740,9 @@ discard block
		block discarded – undo
5721	5740	return true;
5722	5741	}
5723	5742
	5743	+ /**
	5744	+ * @param string $file
	5745	+ */
5724	5746	public static function check_privacy( $file ) {
5725	5747	static $is_site_publicly_accessible = null;
5726	5748
		@@ -6293,9 +6315,7 @@ discard block
		block discarded – undo
6293	6315	*
6294	6316	* Attached to `style_loader_src` filter.
6295	6317	*
6296		- * @param string $tag The tag that would link to the external asset.
6297	6318	* @param string $handle The registered handle of the script in question.
6298		- * @param string $href The url of the asset in question.
6299	6319	*/
6300	6320	public static function set_suffix_on_min( $src, $handle ) {
6301	6321	if ( false === strpos( $src, '.min.css' ) ) {
		@@ -6671,8 +6691,8 @@ discard block
		block discarded – undo
6671	6691	* - Absolute URLs `http://domain.com/feh.png`
6672	6692	* - Domain root relative URLs `/feh.png`
6673	6693	*
6674		- * @param $css string: The raw CSS -- should be read in directly from the file.
6675		- * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
	6694	+ * @param string $css string: The raw CSS -- should be read in directly from the file.
	6695	+ * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6676	6696	*
6677	6697	* @return mixed\|string
6678	6698	*/
		@@ -6971,7 +6991,6 @@ discard block
		block discarded – undo
6971	6991	}
6972	6992
6973	6993	/**
6974		- * @param mixed $result Value for the user's option
6975	6994	* @return mixed
6976	6995	*/
6977	6996	function get_user_option_meta_box_order_dashboard( $sorted ) {

		@@ -149,7 +149,7 @@
		block discarded – undo
149	149	/**
150	150	* Get the token stored in the auth cookie.
151	151	*
152		- * @return ?string
	152	+ * @return string
153	153	*/
154	154	private function token_from_cookie() {
155	155	if ( isset( $_COOKIE[ self::JWT_AUTH_TOKEN_COOKIE_NAME ] ) ) {

Automattic / jetpack

Push — e2e-separate-node-project ( a4d8ee...3e87c6 )

Status

Category

Doc Comments +36 added lines, -17 removed lines patch added patch discarded remove patch

Doc Comments +1 added lines, -1 removed lines patch added patch discarded remove patch