Inspection of "Update dependency page to v1.11.6" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — renovate/page-1.x ( f71012...7fd198 )

unknown

created 2020-09-05 01:16 UTC

Status

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

@@ -55,7 +55,7 @@
 block discarded – undo
 	 *
 	 * @since 5.6.0
 	 *
-	 * @return object The class instance.
+	 * @return Jetpack_Lazy_Images The class instance.
 	 */
 	public static function instance() {
 		if ( is_null( self::$instance ) ) {

Please login to merge, or discard this patch.

class.jetpack.php 1 patch

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

@@ -937,7 +937,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 ) ) {
@@ -1305,7 +1305,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' );
@@ -1415,7 +1415,7 @@  discard block
 block discarded – undo
 	 *
 	 * @param  bool $option
 	 *
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_main_network_option( $option ) {
 		// return '1' or ''
@@ -1426,7 +1426,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();
@@ -1489,7 +1489,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' ) ) {
@@ -2217,7 +2217,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' );
@@ -2662,7 +2662,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 );
@@ -2777,8 +2777,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.
@@ -2789,6 +2789,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,
@@ -3072,6 +3076,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' );
@@ -3100,6 +3107,10 @@  discard block
 block discarded – undo
 	}
 
 	/* Installation */
+
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 		?>
 <!doctype html>
@@ -3869,7 +3880,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();
@@ -4573,6 +4584,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();
@@ -4968,6 +4980,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 );
@@ -5270,7 +5285,7 @@  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 );
@@ -5526,7 +5541,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 ) {
@@ -5651,6 +5665,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();
@@ -5732,6 +5747,9 @@  discard block
 block discarded – undo
 		return true;
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -5812,6 +5830,9 @@  discard block
 block discarded – undo
 		}
 	}
 
+	/**
+	 * @param string $url
+	 */
 	public static function staticize_subdomain( $url ) {
 
 		// Extract hostname from URL
@@ -6312,9 +6333,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' ) ) {
@@ -6556,8 +6575,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
 	 */
@@ -6856,7 +6875,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.

		@@ -55,7 +55,7 @@
		block discarded – undo
55	55	*
56	56	* @since 5.6.0
57	57	*
58		- * @return object The class instance.
	58	+ * @return Jetpack_Lazy_Images The class instance.
59	59	*/
60	60	public static function instance() {
61	61	if ( is_null( self::$instance ) ) {

		@@ -937,7 +937,7 @@ discard block
		block discarded – undo
937	937	* This is ported over from the manage module, which has been deprecated and baked in here.
938	938	*
939	939	* @param $domains
940		- * @return array
	940	+ * @return string[]
941	941	*/
942	942	function allow_wpcom_domain( $domains ) {
943	943	if ( empty( $domains ) ) {
		@@ -1305,7 +1305,7 @@ discard block
		block discarded – undo
1305	1305	/**
1306	1306	* Does the network allow admins to add new users.
1307	1307	*
1308		- * @return boolian
	1308	+ * @return boolean
1309	1309	*/
1310	1310	static function network_add_new_users( $option = null ) {
1311	1311	return (bool) get_site_option( 'add_new_users' );
		@@ -1415,7 +1415,7 @@ discard block
		block discarded – undo
1415	1415	*
1416	1416	* @param bool $option
1417	1417	*
1418		- * @return boolean
	1418	+ * @return string
1419	1419	*/
1420	1420	public function is_main_network_option( $option ) {
1421	1421	// return '1' or ''
		@@ -1426,7 +1426,7 @@ discard block
		block discarded – undo
1426	1426	* Return true if we are with multi-site or multi-network false if we are dealing with single site.
1427	1427	*
1428	1428	* @param string $option
1429		- * @return boolean
	1429	+ * @return string
1430	1430	*/
1431	1431	public function is_multisite( $option ) {
1432	1432	return (string) (bool) is_multisite();
		@@ -1489,7 +1489,7 @@ discard block
		block discarded – undo
1489	1489	/**
1490	1490	* Returns true if the site has file write access false otherwise.
1491	1491	*
1492		- * @return string ( '1' \| '0' )
	1492	+ * @return integer ( '1' \| '0' )
1493	1493	**/
1494	1494	public static function file_system_write_access() {
1495	1495	if ( ! function_exists( 'get_filesystem_method' ) ) {
		@@ -2217,7 +2217,7 @@ discard block
		block discarded – undo
2217	2217	* @param int $user_id The user id.
2218	2218	* @param string $token The user token.
2219	2219	* @param bool $is_master_user Whether the user is the master user.
2220		- * @return bool
	2220	+ * @return boolean\|null
2221	2221	*/
2222	2222	public static function update_user_token( $user_id, $token, $is_master_user ) {
2223	2223	_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
		@@ -2662,7 +2662,7 @@ discard block
		block discarded – undo
2662	2662	*
2663	2663	* @param string $tag Tag as it appears in each module heading.
2664	2664	*
2665		- * @return mixed
	2665	+ * @return string
2666	2666	*/
2667	2667	public static function translate_module_tag( $tag ) {
2668	2668	return jetpack_get_module_i18n_tag( $tag );
		@@ -2777,8 +2777,8 @@ discard block
		block discarded – undo
2777	2777	* Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2778	2778	* is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2779	2779	*
2780		- * @param $string
2781		- * @return mixed
	2780	+ * @param string $string
	2781	+ * @return string\|null
2782	2782	*/
2783	2783	public static function alias_directories( $string ) {
2784	2784	// ABSPATH has a trailing slash.
		@@ -2789,6 +2789,10 @@ discard block
		block discarded – undo
2789	2789	return $string;
2790	2790	}
2791	2791
	2792	+ /**
	2793	+ * @param boolean $redirect
	2794	+ * @param boolean $send_state_messages
	2795	+ */
2792	2796	public static function activate_default_modules(
2793	2797	$min_version = false,
2794	2798	$max_version = false,
		@@ -3072,6 +3076,9 @@ discard block
		block discarded – undo
3072	3076	return self::update_active_modules( $new );
3073	3077	}
3074	3078
	3079	+ /**
	3080	+ * @param string $module
	3081	+ */
3075	3082	public static function enable_module_configurable( $module ) {
3076	3083	$module = self::get_module_slug( $module );
3077	3084	add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
		@@ -3100,6 +3107,10 @@ discard block
		block discarded – undo
3100	3107	}
3101	3108
3102	3109	/* Installation */
	3110	+
	3111	+ /**
	3112	+ * @param string $message
	3113	+ */
3103	3114	public static function bail_on_activation( $message, $deactivate = true ) {
3104	3115	?>
3105	3116	<!doctype html>
		@@ -3869,7 +3880,7 @@ discard block
		block discarded – undo
3869	3880	* Add help to the Jetpack page
3870	3881	*
3871	3882	* @since Jetpack (1.2.3)
3872		- * @return false if not the Jetpack page
	3883	+ * @return false\|null if not the Jetpack page
3873	3884	*/
3874	3885	function admin_help() {
3875	3886	$current_screen = get_current_screen();
		@@ -4573,6 +4584,7 @@ discard block
		block discarded – undo
4573	4584
4574	4585	/**
4575	4586	* Record a stat for later output. This will only currently output in the admin_footer.
	4587	+ * @param string $group
4576	4588	*/
4577	4589	function stat( $group, $detail ) {
4578	4590	$this->initialize_stats();
		@@ -4968,6 +4980,9 @@ discard block
		block discarded – undo
4968	4980	return $url;
4969	4981	}
4970	4982
	4983	+ /**
	4984	+ * @param string $actionurl
	4985	+ */
4971	4986	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4972	4987	$actionurl = str_replace( '&', '&', $actionurl );
4973	4988	return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
		@@ -5270,7 +5285,7 @@ discard block
		block discarded – undo
5270	5285	* @param String $action The action name.
5271	5286	* @param Integer $user_id The user identifier.
5272	5287	* @param Integer $exp Expiration time in seconds.
5273		- * @return array
	5288	+ * @return boolean
5274	5289	*/
5275	5290	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5276	5291	return self::connection()->generate_secrets( $action, $user_id, $exp );
		@@ -5526,7 +5541,6 @@ discard block
		block discarded – undo
5526	5541	* @deprecated since 8.9.0
5527	5542	* @see Automattic\Jetpack\Connection\Rest_Authentication::wp_rest_authentication_errors()
5528	5543	*
5529		- * @param WP_Error\|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
5530	5544	* @return WP_Error\|boolean\|null {@see WP_JSON_Server::check_authentication}
5531	5545	*/
5532	5546	public function wp_rest_authentication_errors( $value ) {
		@@ -5651,6 +5665,7 @@ discard block
		block discarded – undo
5651	5665	* @param string $key
5652	5666	* @param string $value
5653	5667	* @param bool $restate private
	5668	+ * @return string
5654	5669	*/
5655	5670	public static function state( $key = null, $value = null, $restate = false ) {
5656	5671	static $state = array();
		@@ -5732,6 +5747,9 @@ discard block
		block discarded – undo
5732	5747	return true;
5733	5748	}
5734	5749
	5750	+ /**
	5751	+ * @param string $file
	5752	+ */
5735	5753	public static function check_privacy( $file ) {
5736	5754	static $is_site_publicly_accessible = null;
5737	5755
		@@ -5812,6 +5830,9 @@ discard block
		block discarded – undo
5812	5830	}
5813	5831	}
5814	5832
	5833	+ /**
	5834	+ * @param string $url
	5835	+ */
5815	5836	public static function staticize_subdomain( $url ) {
5816	5837
5817	5838	// Extract hostname from URL
		@@ -6312,9 +6333,7 @@ discard block
		block discarded – undo
6312	6333	*
6313	6334	* Attached to `style_loader_src` filter.
6314	6335	*
6315		- * @param string $tag The tag that would link to the external asset.
6316	6336	* @param string $handle The registered handle of the script in question.
6317		- * @param string $href The url of the asset in question.
6318	6337	*/
6319	6338	public static function set_suffix_on_min( $src, $handle ) {
6320	6339	if ( false === strpos( $src, '.min.css' ) ) {
		@@ -6556,8 +6575,8 @@ discard block
		block discarded – undo
6556	6575	* - Absolute URLs `http://domain.com/feh.png`
6557	6576	* - Domain root relative URLs `/feh.png`
6558	6577	*
6559		- * @param $css string: The raw CSS -- should be read in directly from the file.
6560		- * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
	6578	+ * @param string $css string: The raw CSS -- should be read in directly from the file.
	6579	+ * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6561	6580	*
6562	6581	* @return mixed\|string
6563	6582	*/
		@@ -6856,7 +6875,6 @@ discard block
		block discarded – undo
6856	6875	}
6857	6876
6858	6877	/**
6859		- * @param mixed $result Value for the user's option
6860	6878	* @return mixed
6861	6879	*/
6862	6880	function get_user_option_meta_box_order_dashboard( $sorted ) {

Automattic / jetpack

Push — renovate/page-1.x ( f71012...7fd198 )

Status

Category

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

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