Inspection of "[not verified] WIP" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — try/minimal-authorize ( 0f284f...df3061 )

unknown

created 2019-07-24 04:56 UTC

Status

Doc Comments +38 added lines, -16 removed lines patch added patch discarded remove patch

@@ -778,7 +778,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 ) ) {
@@ -1274,7 +1274,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' );
@@ -1379,7 +1379,7 @@  discard block
 block discarded – undo
 	 * database which could be set to anything as opposed to what this function returns.
 	 * @param  bool  $option
 	 *
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_main_network_option( $option ) {
 		// return '1' or ''
@@ -1390,7 +1390,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();
@@ -1452,7 +1452,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' ) ) {
@@ -2180,6 +2180,7 @@  discard block
 block discarded – undo
 	 * @param int $user_id
 	 * @param string $token
 	 * return bool
+	 * @param boolean $is_master_user
 	 */
 	public static function update_user_token( $user_id, $token, $is_master_user ) {
 		// not designed for concurrent updates
@@ -2624,7 +2625,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 +2797,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.
@@ -3057,6 +3058,9 @@  discard block
 block discarded – undo
 		return self::update_active_modules( $new );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function enable_module_configurable( $module ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
@@ -3085,6 +3089,9 @@  discard block
 block discarded – undo
 	}
 
 /* Installation */
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 ?>
 <!doctype html>
@@ -3821,7 +3828,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();
@@ -4551,6 +4558,9 @@  discard block
 block discarded – undo
 		return $raw ? esc_url_raw( $url ) : esc_url( $url );
 	}
 
+	/**
+	 * @return string
+	 */
 	public static function build_authorize_url( $redirect = false, $iframe = false ) {
 		if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
 			$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
@@ -4688,6 +4698,9 @@  discard block
 block discarded – undo
 		return $url;
 	}
 
+	/**
+	 * @return string
+	 */
 	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 );
@@ -4747,6 +4760,7 @@  discard block
 block discarded – undo
 	/**
 	 * Returns the requested Jetpack API URL
 	 *
+	 * @param string $relative_url
 	 * @return string
 	 */
 	public static function api_url( $relative_url ) {
@@ -4942,6 +4956,7 @@  discard block
 block discarded – undo
 	 * Note these tokens are unique per call, NOT static per site for connecting.
 	 *
 	 * @since 2.6
+	 * @param string $action
 	 * @return array
 	 */
 	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
@@ -5504,7 +5519,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 ) {
@@ -5514,6 +5528,10 @@  discard block
 block discarded – undo
 		return $this->rest_authentication_status;
 	}
 
+	/**
+	 * @param integer $timestamp
+	 * @param string $nonce
+	 */
 	function add_nonce( $timestamp, $nonce ) {
 		global $wpdb;
 		static $nonces_used_this_request = array();
@@ -5659,6 +5677,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();
@@ -5715,6 +5734,9 @@  discard block
 block discarded – undo
 		Jetpack::state( null, null, true );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -5797,6 +5819,9 @@  discard block
 block discarded – undo
 		}
 	}
 
+	/**
+	 * @param string $url
+	 */
 	public static function staticize_subdomain( $url ) {
 
 		// Extract hostname from URL
@@ -6352,9 +6377,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' ) ) {
@@ -6541,8 +6564,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
 	 */
@@ -6785,7 +6808,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();
@@ -6841,7 +6864,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.

		@@ -778,7 +778,7 @@ discard block
		block discarded – undo
778	778	* This is ported over from the manage module, which has been deprecated and baked in here.
779	779	*
780	780	* @param $domains
781		- * @return array
	781	+ * @return string[]
782	782	*/
783	783	function allow_wpcom_domain( $domains ) {
784	784	if ( empty( $domains ) ) {
		@@ -1274,7 +1274,7 @@ discard block
		block discarded – undo
1274	1274	}
1275	1275	/**
1276	1276	* Does the network allow admins to add new users.
1277		- * @return boolian
	1277	+ * @return boolean
1278	1278	*/
1279	1279	static function network_add_new_users( $option = null ) {
1280	1280	return (bool) get_site_option( 'add_new_users' );
		@@ -1379,7 +1379,7 @@ discard block
		block discarded – undo
1379	1379	* database which could be set to anything as opposed to what this function returns.
1380	1380	* @param bool $option
1381	1381	*
1382		- * @return boolean
	1382	+ * @return string
1383	1383	*/
1384	1384	public function is_main_network_option( $option ) {
1385	1385	// return '1' or ''
		@@ -1390,7 +1390,7 @@ discard block
		block discarded – undo
1390	1390	* Return true if we are with multi-site or multi-network false if we are dealing with single site.
1391	1391	*
1392	1392	* @param string $option
1393		- * @return boolean
	1393	+ * @return string
1394	1394	*/
1395	1395	public function is_multisite( $option ) {
1396	1396	return (string) (bool) is_multisite();
		@@ -1452,7 +1452,7 @@ discard block
		block discarded – undo
1452	1452
1453	1453	/**
1454	1454	* Returns true if the site has file write access false otherwise.
1455		- * @return string ( '1' \| '0' )
	1455	+ * @return integer ( '1' \| '0' )
1456	1456	**/
1457	1457	public static function file_system_write_access() {
1458	1458	if ( ! function_exists( 'get_filesystem_method' ) ) {
		@@ -2180,6 +2180,7 @@ discard block
		block discarded – undo
2180	2180	* @param int $user_id
2181	2181	* @param string $token
2182	2182	* return bool
	2183	+ * @param boolean $is_master_user
2183	2184	*/
2184	2185	public static function update_user_token( $user_id, $token, $is_master_user ) {
2185	2186	// not designed for concurrent updates
		@@ -2624,7 +2625,7 @@ discard block
		block discarded – undo
2624	2625	*
2625	2626	* @param string $tag Tag as it appears in each module heading.
2626	2627	*
2627		- * @return mixed
	2628	+ * @return string
2628	2629	*/
2629	2630	public static function translate_module_tag( $tag ) {
2630	2631	return jetpack_get_module_i18n_tag( $tag );
		@@ -2796,8 +2797,8 @@ discard block
		block discarded – undo
2796	2797	* Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2797	2798	* is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2798	2799	*
2799		- * @param $string
2800		- * @return mixed
	2800	+ * @param string $string
	2801	+ * @return string\|null
2801	2802	*/
2802	2803	public static function alias_directories( $string ) {
2803	2804	// ABSPATH has a trailing slash.
		@@ -3057,6 +3058,9 @@ discard block
		block discarded – undo
3057	3058	return self::update_active_modules( $new );
3058	3059	}
3059	3060
	3061	+ /**
	3062	+ * @param string $module
	3063	+ */
3060	3064	public static function enable_module_configurable( $module ) {
3061	3065	$module = Jetpack::get_module_slug( $module );
3062	3066	add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
		@@ -3085,6 +3089,9 @@ discard block
		block discarded – undo
3085	3089	}
3086	3090
3087	3091	/* Installation */
	3092	+ /**
	3093	+ * @param string $message
	3094	+ */
3088	3095	public static function bail_on_activation( $message, $deactivate = true ) {
3089	3096	?>
3090	3097	<!doctype html>
		@@ -3821,7 +3828,7 @@ discard block
		block discarded – undo
3821	3828	* Add help to the Jetpack page
3822	3829	*
3823	3830	* @since Jetpack (1.2.3)
3824		- * @return false if not the Jetpack page
	3831	+ * @return false\|null if not the Jetpack page
3825	3832	*/
3826	3833	function admin_help() {
3827	3834	$current_screen = get_current_screen();
		@@ -4551,6 +4558,9 @@ discard block
		block discarded – undo
4551	4558	return $raw ? esc_url_raw( $url ) : esc_url( $url );
4552	4559	}
4553	4560
	4561	+ /**
	4562	+ * @return string
	4563	+ */
4554	4564	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4555	4565	if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4556	4566	$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
		@@ -4688,6 +4698,9 @@ discard block
		block discarded – undo
4688	4698	return $url;
4689	4699	}
4690	4700
	4701	+ /**
	4702	+ * @return string
	4703	+ */
4691	4704	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4692	4705	$actionurl = str_replace( '&', '&', $actionurl );
4693	4706	return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
		@@ -4747,6 +4760,7 @@ discard block
		block discarded – undo
4747	4760	/**
4748	4761	* Returns the requested Jetpack API URL
4749	4762	*
	4763	+ * @param string $relative_url
4750	4764	* @return string
4751	4765	*/
4752	4766	public static function api_url( $relative_url ) {
		@@ -4942,6 +4956,7 @@ discard block
		block discarded – undo
4942	4956	* Note these tokens are unique per call, NOT static per site for connecting.
4943	4957	*
4944	4958	* @since 2.6
	4959	+ * @param string $action
4945	4960	* @return array
4946	4961	*/
4947	4962	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
		@@ -5504,7 +5519,6 @@ discard block
		block discarded – undo
5504	5519	/**
5505	5520	* Report authentication status to the WP REST API.
5506	5521	*
5507		- * @param WP_Error\|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
5508	5522	* @return WP_Error\|boolean\|null {@see WP_JSON_Server::check_authentication}
5509	5523	*/
5510	5524	public function wp_rest_authentication_errors( $value ) {
		@@ -5514,6 +5528,10 @@ discard block
		block discarded – undo
5514	5528	return $this->rest_authentication_status;
5515	5529	}
5516	5530
	5531	+ /**
	5532	+ * @param integer $timestamp
	5533	+ * @param string $nonce
	5534	+ */
5517	5535	function add_nonce( $timestamp, $nonce ) {
5518	5536	global $wpdb;
5519	5537	static $nonces_used_this_request = array();
		@@ -5659,6 +5677,7 @@ discard block
		block discarded – undo
5659	5677	* @param string $key
5660	5678	* @param string $value
5661	5679	* @param bool $restate private
	5680	+ * @return string
5662	5681	*/
5663	5682	public static function state( $key = null, $value = null, $restate = false ) {
5664	5683	static $state = array();
		@@ -5715,6 +5734,9 @@ discard block
		block discarded – undo
5715	5734	Jetpack::state( null, null, true );
5716	5735	}
5717	5736
	5737	+ /**
	5738	+ * @param string $file
	5739	+ */
5718	5740	public static function check_privacy( $file ) {
5719	5741	static $is_site_publicly_accessible = null;
5720	5742
		@@ -5797,6 +5819,9 @@ discard block
		block discarded – undo
5797	5819	}
5798	5820	}
5799	5821
	5822	+ /**
	5823	+ * @param string $url
	5824	+ */
5800	5825	public static function staticize_subdomain( $url ) {
5801	5826
5802	5827	// Extract hostname from URL
		@@ -6352,9 +6377,7 @@ discard block
		block discarded – undo
6352	6377	*
6353	6378	* Attached to `style_loader_src` filter.
6354	6379	*
6355		- * @param string $tag The tag that would link to the external asset.
6356	6380	* @param string $handle The registered handle of the script in question.
6357		- * @param string $href The url of the asset in question.
6358	6381	*/
6359	6382	public static function set_suffix_on_min( $src, $handle ) {
6360	6383	if ( false === strpos( $src, '.min.css' ) ) {
		@@ -6541,8 +6564,8 @@ discard block
		block discarded – undo
6541	6564	* - Absolute URLs `http://domain.com/feh.png`
6542	6565	* - Domain root relative URLs `/feh.png`
6543	6566	*
6544		- * @param $css string: The raw CSS -- should be read in directly from the file.
6545		- * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
	6567	+ * @param string $css string: The raw CSS -- should be read in directly from the file.
	6568	+ * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6546	6569	*
6547	6570	* @return mixed\|string
6548	6571	*/
		@@ -6785,7 +6808,7 @@ discard block
		block discarded – undo
6785	6808	/**
6786	6809	* Stores and prints out domains to prefetch for page speed optimization.
6787	6810	*
6788		- * @param mixed $new_urls
	6811	+ * @param string[] $new_urls
6789	6812	*/
6790	6813	public static function dns_prefetch( $new_urls = null ) {
6791	6814	static $prefetch_urls = array();
		@@ -6841,7 +6864,6 @@ discard block
		block discarded – undo
6841	6864	}
6842	6865
6843	6866	/**
6844		- * @param mixed $result Value for the user's option
6845	6867	* @return mixed
6846	6868	*/
6847	6869	function get_user_option_meta_box_order_dashboard( $sorted ) {

Automattic / jetpack

Push — try/minimal-authorize ( 0f284f...df3061 )

Status

Category

Doc Comments +38 added lines, -16 removed lines patch added patch discarded remove patch