Inspection of "Remove module_configuration_screen function and re..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — fix/remove-legacy-config-pages ( 567494...37f1a4 )

unknown

created 2019-04-10 15:38 UTC

Status

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

@@ -719,7 +719,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' ) ) {
@@ -2148,6 +2148,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
@@ -2550,6 +2551,7 @@  discard block
 block discarded – undo
 
 	/**
 	 * Like core's get_file_data implementation, but caches the result.
+	 * @param string $file
 	 */
 	public static function get_file_data( $file, $headers ) {
 		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
@@ -2586,7 +2588,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 );
@@ -2758,8 +2760,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.
@@ -3039,6 +3041,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' );
@@ -3067,6 +3072,9 @@  discard block
 block discarded – undo
 	}
 
 /* Installation */
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 ?>
 <!doctype html>
@@ -3801,7 +3809,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();
@@ -4620,6 +4628,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 );
@@ -4679,6 +4690,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 ) {
@@ -4870,6 +4882,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 ) {
@@ -5404,7 +5417,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 ) {
@@ -5414,6 +5426,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();
@@ -5559,6 +5575,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();
@@ -5615,6 +5632,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;
 
@@ -6247,9 +6267,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' ) ) {
@@ -6432,8 +6450,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
 	 */
@@ -6667,7 +6685,7 @@  discard block
 block discarded – undo
 	 *
 	 * @param string $option_name
 	 *
-	 * @return bool
+	 * @return false|null
 	 */
 	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
 		// Bail if Jump Start has already been dismissed
@@ -6708,7 +6726,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();
@@ -6763,7 +6781,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.

		@@ -719,7 +719,7 @@ discard block
		block discarded – undo
719	719	* This is ported over from the manage module, which has been deprecated and baked in here.
720	720	*
721	721	* @param $domains
722		- * @return array
	722	+ * @return string[]
723	723	*/
724	724	function allow_wpcom_domain( $domains ) {
725	725	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' ) ) {
		@@ -2148,6 +2148,7 @@ discard block
		block discarded – undo
2148	2148	* @param int $user_id
2149	2149	* @param string $token
2150	2150	* return bool
	2151	+ * @param boolean $is_master_user
2151	2152	*/
2152	2153	public static function update_user_token( $user_id, $token, $is_master_user ) {
2153	2154	// not designed for concurrent updates
		@@ -2550,6 +2551,7 @@ discard block
		block discarded – undo
2550	2551
2551	2552	/**
2552	2553	* Like core's get_file_data implementation, but caches the result.
	2554	+ * @param string $file
2553	2555	*/
2554	2556	public static function get_file_data( $file, $headers ) {
2555	2557	//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
		@@ -2586,7 +2588,7 @@ discard block
		block discarded – undo
2586	2588	*
2587	2589	* @param string $tag Tag as it appears in each module heading.
2588	2590	*
2589		- * @return mixed
	2591	+ * @return string
2590	2592	*/
2591	2593	public static function translate_module_tag( $tag ) {
2592	2594	return jetpack_get_module_i18n_tag( $tag );
		@@ -2758,8 +2760,8 @@ discard block
		block discarded – undo
2758	2760	* Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2759	2761	* is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2760	2762	*
2761		- * @param $string
2762		- * @return mixed
	2763	+ * @param string $string
	2764	+ * @return string\|null
2763	2765	*/
2764	2766	public static function alias_directories( $string ) {
2765	2767	// ABSPATH has a trailing slash.
		@@ -3039,6 +3041,9 @@ discard block
		block discarded – undo
3039	3041	return self::update_active_modules( $new );
3040	3042	}
3041	3043
	3044	+ /**
	3045	+ * @param string $module
	3046	+ */
3042	3047	public static function enable_module_configurable( $module ) {
3043	3048	$module = Jetpack::get_module_slug( $module );
3044	3049	add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
		@@ -3067,6 +3072,9 @@ discard block
		block discarded – undo
3067	3072	}
3068	3073
3069	3074	/* Installation */
	3075	+ /**
	3076	+ * @param string $message
	3077	+ */
3070	3078	public static function bail_on_activation( $message, $deactivate = true ) {
3071	3079	?>
3072	3080	<!doctype html>
		@@ -3801,7 +3809,7 @@ discard block
		block discarded – undo
3801	3809	* Add help to the Jetpack page
3802	3810	*
3803	3811	* @since Jetpack (1.2.3)
3804		- * @return false if not the Jetpack page
	3812	+ * @return false\|null if not the Jetpack page
3805	3813	*/
3806	3814	function admin_help() {
3807	3815	$current_screen = get_current_screen();
		@@ -4620,6 +4628,9 @@ discard block
		block discarded – undo
4620	4628	return $url;
4621	4629	}
4622	4630
	4631	+ /**
	4632	+ * @return string
	4633	+ */
4623	4634	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4624	4635	$actionurl = str_replace( '&', '&', $actionurl );
4625	4636	return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
		@@ -4679,6 +4690,7 @@ discard block
		block discarded – undo
4679	4690	/**
4680	4691	* Returns the requested Jetpack API URL
4681	4692	*
	4693	+ * @param string $relative_url
4682	4694	* @return string
4683	4695	*/
4684	4696	public static function api_url( $relative_url ) {
		@@ -4870,6 +4882,7 @@ discard block
		block discarded – undo
4870	4882	* Note these tokens are unique per call, NOT static per site for connecting.
4871	4883	*
4872	4884	* @since 2.6
	4885	+ * @param string $action
4873	4886	* @return array
4874	4887	*/
4875	4888	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
		@@ -5404,7 +5417,6 @@ discard block
		block discarded – undo
5404	5417	/**
5405	5418	* Report authentication status to the WP REST API.
5406	5419	*
5407		- * @param WP_Error\|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
5408	5420	* @return WP_Error\|boolean\|null {@see WP_JSON_Server::check_authentication}
5409	5421	*/
5410	5422	public function wp_rest_authentication_errors( $value ) {
		@@ -5414,6 +5426,10 @@ discard block
		block discarded – undo
5414	5426	return $this->rest_authentication_status;
5415	5427	}
5416	5428
	5429	+ /**
	5430	+ * @param integer $timestamp
	5431	+ * @param string $nonce
	5432	+ */
5417	5433	function add_nonce( $timestamp, $nonce ) {
5418	5434	global $wpdb;
5419	5435	static $nonces_used_this_request = array();
		@@ -5559,6 +5575,7 @@ discard block
		block discarded – undo
5559	5575	* @param string $key
5560	5576	* @param string $value
5561	5577	* @param bool $restate private
	5578	+ * @return string
5562	5579	*/
5563	5580	public static function state( $key = null, $value = null, $restate = false ) {
5564	5581	static $state = array();
		@@ -5615,6 +5632,9 @@ discard block
		block discarded – undo
5615	5632	Jetpack::state( null, null, true );
5616	5633	}
5617	5634
	5635	+ /**
	5636	+ * @param string $file
	5637	+ */
5618	5638	public static function check_privacy( $file ) {
5619	5639	static $is_site_publicly_accessible = null;
5620	5640
		@@ -6247,9 +6267,7 @@ discard block
		block discarded – undo
6247	6267	*
6248	6268	* Attached to `style_loader_src` filter.
6249	6269	*
6250		- * @param string $tag The tag that would link to the external asset.
6251	6270	* @param string $handle The registered handle of the script in question.
6252		- * @param string $href The url of the asset in question.
6253	6271	*/
6254	6272	public static function set_suffix_on_min( $src, $handle ) {
6255	6273	if ( false === strpos( $src, '.min.css' ) ) {
		@@ -6432,8 +6450,8 @@ discard block
		block discarded – undo
6432	6450	* - Absolute URLs `http://domain.com/feh.png`
6433	6451	* - Domain root relative URLs `/feh.png`
6434	6452	*
6435		- * @param $css string: The raw CSS -- should be read in directly from the file.
6436		- * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
	6453	+ * @param string $css string: The raw CSS -- should be read in directly from the file.
	6454	+ * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6437	6455	*
6438	6456	* @return mixed\|string
6439	6457	*/
		@@ -6667,7 +6685,7 @@ discard block
		block discarded – undo
6667	6685	*
6668	6686	* @param string $option_name
6669	6687	*
6670		- * @return bool
	6688	+ * @return false\|null
6671	6689	*/
6672	6690	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6673	6691	// Bail if Jump Start has already been dismissed
		@@ -6708,7 +6726,7 @@ discard block
		block discarded – undo
6708	6726	/**
6709	6727	* Stores and prints out domains to prefetch for page speed optimization.
6710	6728	*
6711		- * @param mixed $new_urls
	6729	+ * @param string[] $new_urls
6712	6730	*/
6713	6731	public static function dns_prefetch( $new_urls = null ) {
6714	6732	static $prefetch_urls = array();
		@@ -6763,7 +6781,6 @@ discard block
		block discarded – undo
6763	6781	}
6764	6782
6765	6783	/**
6766		- * @param mixed $result Value for the user's option
6767	6784	* @return mixed
6768	6785	*/
6769	6786	function get_user_option_meta_box_order_dashboard( $sorted ) {

Automattic / jetpack

Push — fix/remove-legacy-config-pages ( 567494...37f1a4 )

Status

Category

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