Inspection of "[not verified] Merge branch 'master' into add/redi..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/redirect-everything ( 50f94e...5deed2 )

unknown

created 2020-03-31 17:22 UTC

Status

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

@@ -411,7 +411,7 @@  discard block
 block discarded – undo
 	 *
 	 * @access public
 	 *
-	 * @return int|null
+	 * @return null|double
 	 */
 	public function get_sync_progress_percentage() {
 		if ( ! $this->is_started() || $this->is_finished() ) {
@@ -625,7 +625,7 @@  discard block
 block discarded – undo
 	 * @access private
 	 *
 	 * @param string $name    Name of the option.
-	 * @param mixed  $default Default value of the option.
+	 * @param integer  $default Default value of the option.
 	 * @return mixed Option value.
 	 */
 	private function get_status_option( $name, $default = null ) {

Please login to merge, or discard this patch.

class.jetpack.php 1 patch

Doc Comments +32 added lines, -24 removed lines patch added patch discarded remove patch

@@ -893,7 +893,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 ) ) {
@@ -1323,7 +1323,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' );
@@ -1433,7 +1433,7 @@  discard block
 block discarded – undo
 	 *
 	 * @param  bool $option
 	 *
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_main_network_option( $option ) {
 		// return '1' or ''
@@ -1444,7 +1444,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();
@@ -1507,7 +1507,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' ) ) {
@@ -2229,7 +2229,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' );
@@ -2673,7 +2673,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 );
@@ -2845,8 +2845,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.
@@ -2857,6 +2857,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,
@@ -3140,6 +3144,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' );
@@ -3168,6 +3175,10 @@  discard block
 block discarded – undo
 	}
 
 	/* Installation */
+
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 		?>
 <!doctype html>
@@ -3923,7 +3934,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();
@@ -5222,7 +5233,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 );
@@ -5542,7 +5553,6 @@  discard block
 block discarded – undo
 	/**
 	 * Report authentication status to the WP REST API.
 	 *
-	 * @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 ) {
@@ -5669,6 +5679,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();
@@ -5729,6 +5740,9 @@  discard block
 block discarded – undo
 		self::state( null, null, true );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -5809,6 +5823,9 @@  discard block
 block discarded – undo
 		}
 	}
 
+	/**
+	 * @param string $url
+	 */
 	public static function staticize_subdomain( $url ) {
 
 		// Extract hostname from URL
@@ -6326,9 +6343,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' ) ) {
@@ -6535,8 +6550,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
 	 */
@@ -6806,12 +6821,6 @@  discard block
 block discarded – undo
 	 *
 	 * 		Additional arguments to build the url
 	 *
-	 * 		@param string $site URL of the current site
-	 * 		@param string $path Additional path to be appended to the URL
-	 * 		@param string $query Query parameters to be added to the URL
-	 * 		@param string $anchor Anchor to be added to the URL
-
-	 * }
 	 *
 	 *
 	 * @return string The built URL
@@ -6846,7 +6855,7 @@  discard block
 block discarded – undo
 	/**
 	 * Stores and prints out domains to prefetch for page speed optimization.
 	 *
-	 * @param mixed $new_urls
+	 * @param string[] $new_urls
 	 */
 	public static function dns_prefetch( $new_urls = null ) {
 		static $prefetch_urls = array();
@@ -6903,7 +6912,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.

		@@ -411,7 +411,7 @@ discard block
		block discarded – undo
411	411	*
412	412	* @access public
413	413	*
414		- * @return int\|null
	414	+ * @return null\|double
415	415	*/
416	416	public function get_sync_progress_percentage() {
417	417	if ( ! $this->is_started() \|\| $this->is_finished() ) {
		@@ -625,7 +625,7 @@ discard block
		block discarded – undo
625	625	* @access private
626	626	*
627	627	* @param string $name Name of the option.
628		- * @param mixed $default Default value of the option.
	628	+ * @param integer $default Default value of the option.
629	629	* @return mixed Option value.
630	630	*/
631	631	private function get_status_option( $name, $default = null ) {

		@@ -893,7 +893,7 @@ discard block
		block discarded – undo
893	893	* This is ported over from the manage module, which has been deprecated and baked in here.
894	894	*
895	895	* @param $domains
896		- * @return array
	896	+ * @return string[]
897	897	*/
898	898	function allow_wpcom_domain( $domains ) {
899	899	if ( empty( $domains ) ) {
		@@ -1323,7 +1323,7 @@ discard block
		block discarded – undo
1323	1323	/**
1324	1324	* Does the network allow admins to add new users.
1325	1325	*
1326		- * @return boolian
	1326	+ * @return boolean
1327	1327	*/
1328	1328	static function network_add_new_users( $option = null ) {
1329	1329	return (bool) get_site_option( 'add_new_users' );
		@@ -1433,7 +1433,7 @@ discard block
		block discarded – undo
1433	1433	*
1434	1434	* @param bool $option
1435	1435	*
1436		- * @return boolean
	1436	+ * @return string
1437	1437	*/
1438	1438	public function is_main_network_option( $option ) {
1439	1439	// return '1' or ''
		@@ -1444,7 +1444,7 @@ discard block
		block discarded – undo
1444	1444	* Return true if we are with multi-site or multi-network false if we are dealing with single site.
1445	1445	*
1446	1446	* @param string $option
1447		- * @return boolean
	1447	+ * @return string
1448	1448	*/
1449	1449	public function is_multisite( $option ) {
1450	1450	return (string) (bool) is_multisite();
		@@ -1507,7 +1507,7 @@ discard block
		block discarded – undo
1507	1507	/**
1508	1508	* Returns true if the site has file write access false otherwise.
1509	1509	*
1510		- * @return string ( '1' \| '0' )
	1510	+ * @return integer ( '1' \| '0' )
1511	1511	**/
1512	1512	public static function file_system_write_access() {
1513	1513	if ( ! function_exists( 'get_filesystem_method' ) ) {
		@@ -2229,7 +2229,7 @@ discard block
		block discarded – undo
2229	2229	* @param int $user_id The user id.
2230	2230	* @param string $token The user token.
2231	2231	* @param bool $is_master_user Whether the user is the master user.
2232		- * @return bool
	2232	+ * @return boolean\|null
2233	2233	*/
2234	2234	public static function update_user_token( $user_id, $token, $is_master_user ) {
2235	2235	_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
		@@ -2673,7 +2673,7 @@ discard block
		block discarded – undo
2673	2673	*
2674	2674	* @param string $tag Tag as it appears in each module heading.
2675	2675	*
2676		- * @return mixed
	2676	+ * @return string
2677	2677	*/
2678	2678	public static function translate_module_tag( $tag ) {
2679	2679	return jetpack_get_module_i18n_tag( $tag );
		@@ -2845,8 +2845,8 @@ discard block
		block discarded – undo
2845	2845	* Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2846	2846	* is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2847	2847	*
2848		- * @param $string
2849		- * @return mixed
	2848	+ * @param string $string
	2849	+ * @return string\|null
2850	2850	*/
2851	2851	public static function alias_directories( $string ) {
2852	2852	// ABSPATH has a trailing slash.
		@@ -2857,6 +2857,10 @@ discard block
		block discarded – undo
2857	2857	return $string;
2858	2858	}
2859	2859
	2860	+ /**
	2861	+ * @param boolean $redirect
	2862	+ * @param boolean $send_state_messages
	2863	+ */
2860	2864	public static function activate_default_modules(
2861	2865	$min_version = false,
2862	2866	$max_version = false,
		@@ -3140,6 +3144,9 @@ discard block
		block discarded – undo
3140	3144	return self::update_active_modules( $new );
3141	3145	}
3142	3146
	3147	+ /**
	3148	+ * @param string $module
	3149	+ */
3143	3150	public static function enable_module_configurable( $module ) {
3144	3151	$module = self::get_module_slug( $module );
3145	3152	add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
		@@ -3168,6 +3175,10 @@ discard block
		block discarded – undo
3168	3175	}
3169	3176
3170	3177	/* Installation */
	3178	+
	3179	+ /**
	3180	+ * @param string $message
	3181	+ */
3171	3182	public static function bail_on_activation( $message, $deactivate = true ) {
3172	3183	?>
3173	3184	<!doctype html>
		@@ -3923,7 +3934,7 @@ discard block
		block discarded – undo
3923	3934	* Add help to the Jetpack page
3924	3935	*
3925	3936	* @since Jetpack (1.2.3)
3926		- * @return false if not the Jetpack page
	3937	+ * @return false\|null if not the Jetpack page
3927	3938	*/
3928	3939	function admin_help() {
3929	3940	$current_screen = get_current_screen();
		@@ -5222,7 +5233,7 @@ discard block
		block discarded – undo
5222	5233	* @param String $action The action name.
5223	5234	* @param Integer $user_id The user identifier.
5224	5235	* @param Integer $exp Expiration time in seconds.
5225		- * @return array
	5236	+ * @return boolean
5226	5237	*/
5227	5238	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5228	5239	return self::connection()->generate_secrets( $action, $user_id, $exp );
		@@ -5542,7 +5553,6 @@ discard block
		block discarded – undo
5542	5553	/**
5543	5554	* Report authentication status to the WP REST API.
5544	5555	*
5545		- * @param WP_Error\|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
5546	5556	* @return WP_Error\|boolean\|null {@see WP_JSON_Server::check_authentication}
5547	5557	*/
5548	5558	public function wp_rest_authentication_errors( $value ) {
		@@ -5669,6 +5679,7 @@ discard block
		block discarded – undo
5669	5679	* @param string $key
5670	5680	* @param string $value
5671	5681	* @param bool $restate private
	5682	+ * @return string
5672	5683	*/
5673	5684	public static function state( $key = null, $value = null, $restate = false ) {
5674	5685	static $state = array();
		@@ -5729,6 +5740,9 @@ discard block
		block discarded – undo
5729	5740	self::state( null, null, true );
5730	5741	}
5731	5742
	5743	+ /**
	5744	+ * @param string $file
	5745	+ */
5732	5746	public static function check_privacy( $file ) {
5733	5747	static $is_site_publicly_accessible = null;
5734	5748
		@@ -5809,6 +5823,9 @@ discard block
		block discarded – undo
5809	5823	}
5810	5824	}
5811	5825
	5826	+ /**
	5827	+ * @param string $url
	5828	+ */
5812	5829	public static function staticize_subdomain( $url ) {
5813	5830
5814	5831	// Extract hostname from URL
		@@ -6326,9 +6343,7 @@ discard block
		block discarded – undo
6326	6343	*
6327	6344	* Attached to `style_loader_src` filter.
6328	6345	*
6329		- * @param string $tag The tag that would link to the external asset.
6330	6346	* @param string $handle The registered handle of the script in question.
6331		- * @param string $href The url of the asset in question.
6332	6347	*/
6333	6348	public static function set_suffix_on_min( $src, $handle ) {
6334	6349	if ( false === strpos( $src, '.min.css' ) ) {
		@@ -6535,8 +6550,8 @@ discard block
		block discarded – undo
6535	6550	* - Absolute URLs `http://domain.com/feh.png`
6536	6551	* - Domain root relative URLs `/feh.png`
6537	6552	*
6538		- * @param $css string: The raw CSS -- should be read in directly from the file.
6539		- * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
	6553	+ * @param string $css string: The raw CSS -- should be read in directly from the file.
	6554	+ * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6540	6555	*
6541	6556	* @return mixed\|string
6542	6557	*/
		@@ -6806,12 +6821,6 @@ discard block
		block discarded – undo
6806	6821	*
6807	6822	* Additional arguments to build the url
6808	6823	*
6809		- * @param string $site URL of the current site
6810		- * @param string $path Additional path to be appended to the URL
6811		- * @param string $query Query parameters to be added to the URL
6812		- * @param string $anchor Anchor to be added to the URL
6813		-
6814		- * }
6815	6824	*
6816	6825	*
6817	6826	* @return string The built URL
		@@ -6846,7 +6855,7 @@ discard block
		block discarded – undo
6846	6855	/**
6847	6856	* Stores and prints out domains to prefetch for page speed optimization.
6848	6857	*
6849		- * @param mixed $new_urls
	6858	+ * @param string[] $new_urls
6850	6859	*/
6851	6860	public static function dns_prefetch( $new_urls = null ) {
6852	6861	static $prefetch_urls = array();
		@@ -6903,7 +6912,6 @@ discard block
		block discarded – undo
6903	6912	}
6904	6913
6905	6914	/**
6906		- * @param mixed $result Value for the user's option
6907	6915	* @return mixed
6908	6916	*/
6909	6917	function get_user_option_meta_box_order_dashboard( $sorted ) {

Automattic / jetpack

Push — add/redirect-everything ( 50f94e...5deed2 )

Status

Category

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

Doc Comments +32 added lines, -24 removed lines patch added patch discarded remove patch