Inspection of "Jetpack: build_connect_url" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — build-authorize-url ( 21b5b7 )

unknown

created 2019-08-19 21:37 UTC

Status

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

@@ -781,7 +781,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 ) ) {
@@ -1239,7 +1239,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' );
@@ -1344,7 +1344,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 ''
@@ -1355,7 +1355,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();
@@ -1417,7 +1417,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' ) ) {
@@ -2152,6 +2152,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
@@ -2596,7 +2597,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 );
@@ -2768,8 +2769,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.
@@ -3029,6 +3030,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' );
@@ -3057,6 +3061,9 @@  discard block
 block discarded – undo
 	}
 
 /* Installation */
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 ?>
 <!doctype html>
@@ -3772,7 +3779,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();
@@ -4503,6 +4510,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() );
@@ -4642,6 +4652,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 );
@@ -4945,6 +4958,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 ) {
@@ -5234,7 +5248,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 ) {
@@ -5336,6 +5349,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();
@@ -5392,6 +5406,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;
 
@@ -5474,6 +5491,9 @@  discard block
 block discarded – undo
 		}
 	}
 
+	/**
+	 * @param string $url
+	 */
 	public static function staticize_subdomain( $url ) {
 
 		// Extract hostname from URL
@@ -6029,9 +6049,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' ) ) {
@@ -6219,8 +6237,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
 	 */
@@ -6481,7 +6499,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();
@@ -6537,7 +6555,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.

		@@ -781,7 +781,7 @@ discard block
		block discarded – undo
781	781	* This is ported over from the manage module, which has been deprecated and baked in here.
782	782	*
783	783	* @param $domains
784		- * @return array
	784	+ * @return string[]
785	785	*/
786	786	function allow_wpcom_domain( $domains ) {
787	787	if ( empty( $domains ) ) {
		@@ -1239,7 +1239,7 @@ discard block
		block discarded – undo
1239	1239	}
1240	1240	/**
1241	1241	* Does the network allow admins to add new users.
1242		- * @return boolian
	1242	+ * @return boolean
1243	1243	*/
1244	1244	static function network_add_new_users( $option = null ) {
1245	1245	return (bool) get_site_option( 'add_new_users' );
		@@ -1344,7 +1344,7 @@ discard block
		block discarded – undo
1344	1344	* database which could be set to anything as opposed to what this function returns.
1345	1345	* @param bool $option
1346	1346	*
1347		- * @return boolean
	1347	+ * @return string
1348	1348	*/
1349	1349	public function is_main_network_option( $option ) {
1350	1350	// return '1' or ''
		@@ -1355,7 +1355,7 @@ discard block
		block discarded – undo
1355	1355	* Return true if we are with multi-site or multi-network false if we are dealing with single site.
1356	1356	*
1357	1357	* @param string $option
1358		- * @return boolean
	1358	+ * @return string
1359	1359	*/
1360	1360	public function is_multisite( $option ) {
1361	1361	return (string) (bool) is_multisite();
		@@ -1417,7 +1417,7 @@ discard block
		block discarded – undo
1417	1417
1418	1418	/**
1419	1419	* Returns true if the site has file write access false otherwise.
1420		- * @return string ( '1' \| '0' )
	1420	+ * @return integer ( '1' \| '0' )
1421	1421	**/
1422	1422	public static function file_system_write_access() {
1423	1423	if ( ! function_exists( 'get_filesystem_method' ) ) {
		@@ -2152,6 +2152,7 @@ discard block
		block discarded – undo
2152	2152	* @param int $user_id
2153	2153	* @param string $token
2154	2154	* return bool
	2155	+ * @param boolean $is_master_user
2155	2156	*/
2156	2157	public static function update_user_token( $user_id, $token, $is_master_user ) {
2157	2158	// not designed for concurrent updates
		@@ -2596,7 +2597,7 @@ discard block
		block discarded – undo
2596	2597	*
2597	2598	* @param string $tag Tag as it appears in each module heading.
2598	2599	*
2599		- * @return mixed
	2600	+ * @return string
2600	2601	*/
2601	2602	public static function translate_module_tag( $tag ) {
2602	2603	return jetpack_get_module_i18n_tag( $tag );
		@@ -2768,8 +2769,8 @@ discard block
		block discarded – undo
2768	2769	* Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2769	2770	* is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2770	2771	*
2771		- * @param $string
2772		- * @return mixed
	2772	+ * @param string $string
	2773	+ * @return string\|null
2773	2774	*/
2774	2775	public static function alias_directories( $string ) {
2775	2776	// ABSPATH has a trailing slash.
		@@ -3029,6 +3030,9 @@ discard block
		block discarded – undo
3029	3030	return self::update_active_modules( $new );
3030	3031	}
3031	3032
	3033	+ /**
	3034	+ * @param string $module
	3035	+ */
3032	3036	public static function enable_module_configurable( $module ) {
3033	3037	$module = Jetpack::get_module_slug( $module );
3034	3038	add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
		@@ -3057,6 +3061,9 @@ discard block
		block discarded – undo
3057	3061	}
3058	3062
3059	3063	/* Installation */
	3064	+ /**
	3065	+ * @param string $message
	3066	+ */
3060	3067	public static function bail_on_activation( $message, $deactivate = true ) {
3061	3068	?>
3062	3069	<!doctype html>
		@@ -3772,7 +3779,7 @@ discard block
		block discarded – undo
3772	3779	* Add help to the Jetpack page
3773	3780	*
3774	3781	* @since Jetpack (1.2.3)
3775		- * @return false if not the Jetpack page
	3782	+ * @return false\|null if not the Jetpack page
3776	3783	*/
3777	3784	function admin_help() {
3778	3785	$current_screen = get_current_screen();
		@@ -4503,6 +4510,9 @@ discard block
		block discarded – undo
4503	4510	return $raw ? esc_url_raw( $url ) : esc_url( $url );
4504	4511	}
4505	4512
	4513	+ /**
	4514	+ * @return string
	4515	+ */
4506	4516	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4507	4517	if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4508	4518	$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
		@@ -4642,6 +4652,9 @@ discard block
		block discarded – undo
4642	4652	return $url;
4643	4653	}
4644	4654
	4655	+ /**
	4656	+ * @return string
	4657	+ */
4645	4658	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4646	4659	$actionurl = str_replace( '&', '&', $actionurl );
4647	4660	return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
		@@ -4945,6 +4958,7 @@ discard block
		block discarded – undo
4945	4958	* Note these tokens are unique per call, NOT static per site for connecting.
4946	4959	*
4947	4960	* @since 2.6
	4961	+ * @param string $action
4948	4962	* @return array
4949	4963	*/
4950	4964	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
		@@ -5234,7 +5248,6 @@ discard block
		block discarded – undo
5234	5248	/**
5235	5249	* Report authentication status to the WP REST API.
5236	5250	*
5237		- * @param WP_Error\|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
5238	5251	* @return WP_Error\|boolean\|null {@see WP_JSON_Server::check_authentication}
5239	5252	*/
5240	5253	public function wp_rest_authentication_errors( $value ) {
		@@ -5336,6 +5349,7 @@ discard block
		block discarded – undo
5336	5349	* @param string $key
5337	5350	* @param string $value
5338	5351	* @param bool $restate private
	5352	+ * @return string
5339	5353	*/
5340	5354	public static function state( $key = null, $value = null, $restate = false ) {
5341	5355	static $state = array();
		@@ -5392,6 +5406,9 @@ discard block
		block discarded – undo
5392	5406	Jetpack::state( null, null, true );
5393	5407	}
5394	5408
	5409	+ /**
	5410	+ * @param string $file
	5411	+ */
5395	5412	public static function check_privacy( $file ) {
5396	5413	static $is_site_publicly_accessible = null;
5397	5414
		@@ -5474,6 +5491,9 @@ discard block
		block discarded – undo
5474	5491	}
5475	5492	}
5476	5493
	5494	+ /**
	5495	+ * @param string $url
	5496	+ */
5477	5497	public static function staticize_subdomain( $url ) {
5478	5498
5479	5499	// Extract hostname from URL
		@@ -6029,9 +6049,7 @@ discard block
		block discarded – undo
6029	6049	*
6030	6050	* Attached to `style_loader_src` filter.
6031	6051	*
6032		- * @param string $tag The tag that would link to the external asset.
6033	6052	* @param string $handle The registered handle of the script in question.
6034		- * @param string $href The url of the asset in question.
6035	6053	*/
6036	6054	public static function set_suffix_on_min( $src, $handle ) {
6037	6055	if ( false === strpos( $src, '.min.css' ) ) {
		@@ -6219,8 +6237,8 @@ discard block
		block discarded – undo
6219	6237	* - Absolute URLs `http://domain.com/feh.png`
6220	6238	* - Domain root relative URLs `/feh.png`
6221	6239	*
6222		- * @param $css string: The raw CSS -- should be read in directly from the file.
6223		- * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
	6240	+ * @param string $css string: The raw CSS -- should be read in directly from the file.
	6241	+ * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6224	6242	*
6225	6243	* @return mixed\|string
6226	6244	*/
		@@ -6481,7 +6499,7 @@ discard block
		block discarded – undo
6481	6499	/**
6482	6500	* Stores and prints out domains to prefetch for page speed optimization.
6483	6501	*
6484		- * @param mixed $new_urls
	6502	+ * @param string[] $new_urls
6485	6503	*/
6486	6504	public static function dns_prefetch( $new_urls = null ) {
6487	6505	static $prefetch_urls = array();
		@@ -6537,7 +6555,6 @@ discard block
		block discarded – undo
6537	6555	}
6538	6556
6539	6557	/**
6540		- * @param mixed $result Value for the user's option
6541	6558	* @return mixed
6542	6559	*/
6543	6560	function get_user_option_meta_box_order_dashboard( $sorted ) {

Automattic / jetpack

Push — build-authorize-url ( 21b5b7 )

Status

Category

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