Inspection of "Add a small WIP readme" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — try/instant-search-rendering ( cde8b5...089ecc )

unknown

created 2019-08-02 22:20 UTC

Status

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

@@ -718,6 +718,9 @@  discard block
 block discarded – undo
 		}
 	}
 
+	/**
+	 * @param boolean $is_active
+	 */
 	function setup_xmlrpc_handlers( $request_params, $is_active, $is_signed, Jetpack_XMLRPC_Server $xmlrpc_server = null ) {
 		if ( ! isset( $request_params['for'] ) || 'jetpack' != $request_params['for'] ) {
 			return false;
@@ -798,7 +801,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 ) ) {
@@ -1294,7 +1297,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' );
@@ -1399,7 +1402,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 ''
@@ -1410,7 +1413,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();
@@ -1472,7 +1475,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' ) ) {
@@ -2200,6 +2203,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
@@ -2644,7 +2648,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 );
@@ -2816,8 +2820,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.
@@ -3077,6 +3081,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' );
@@ -3105,6 +3112,9 @@  discard block
 block discarded – undo
 	}
 
 /* Installation */
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 ?>
 <!doctype html>
@@ -3839,7 +3849,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();
@@ -4701,6 +4711,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 );
@@ -4760,6 +4773,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 ) {
@@ -4955,6 +4969,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 ) {
@@ -5510,7 +5525,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 ) {
@@ -5520,6 +5534,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();
@@ -5665,6 +5683,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();
@@ -5721,6 +5740,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;
 
@@ -5803,6 +5825,9 @@  discard block
 block discarded – undo
 		}
 	}
 
+	/**
+	 * @param string $url
+	 */
 	public static function staticize_subdomain( $url ) {
 
 		// Extract hostname from URL
@@ -6358,9 +6383,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' ) ) {
@@ -6547,8 +6570,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
 	 */
@@ -6791,7 +6814,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();
@@ -6847,7 +6870,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.

		@@ -718,6 +718,9 @@ discard block
		block discarded – undo
718	718	}
719	719	}
720	720
	721	+ /**
	722	+ * @param boolean $is_active
	723	+ */
721	724	function setup_xmlrpc_handlers( $request_params, $is_active, $is_signed, Jetpack_XMLRPC_Server $xmlrpc_server = null ) {
722	725	if ( ! isset( $request_params['for'] ) \|\| 'jetpack' != $request_params['for'] ) {
723	726	return false;
		@@ -798,7 +801,7 @@ discard block
		block discarded – undo
798	801	* This is ported over from the manage module, which has been deprecated and baked in here.
799	802	*
800	803	* @param $domains
801		- * @return array
	804	+ * @return string[]
802	805	*/
803	806	function allow_wpcom_domain( $domains ) {
804	807	if ( empty( $domains ) ) {
		@@ -1294,7 +1297,7 @@ discard block
		block discarded – undo
1294	1297	}
1295	1298	/**
1296	1299	* Does the network allow admins to add new users.
1297		- * @return boolian
	1300	+ * @return boolean
1298	1301	*/
1299	1302	static function network_add_new_users( $option = null ) {
1300	1303	return (bool) get_site_option( 'add_new_users' );
		@@ -1399,7 +1402,7 @@ discard block
		block discarded – undo
1399	1402	* database which could be set to anything as opposed to what this function returns.
1400	1403	* @param bool $option
1401	1404	*
1402		- * @return boolean
	1405	+ * @return string
1403	1406	*/
1404	1407	public function is_main_network_option( $option ) {
1405	1408	// return '1' or ''
		@@ -1410,7 +1413,7 @@ discard block
		block discarded – undo
1410	1413	* Return true if we are with multi-site or multi-network false if we are dealing with single site.
1411	1414	*
1412	1415	* @param string $option
1413		- * @return boolean
	1416	+ * @return string
1414	1417	*/
1415	1418	public function is_multisite( $option ) {
1416	1419	return (string) (bool) is_multisite();
		@@ -1472,7 +1475,7 @@ discard block
		block discarded – undo
1472	1475
1473	1476	/**
1474	1477	* Returns true if the site has file write access false otherwise.
1475		- * @return string ( '1' \| '0' )
	1478	+ * @return integer ( '1' \| '0' )
1476	1479	**/
1477	1480	public static function file_system_write_access() {
1478	1481	if ( ! function_exists( 'get_filesystem_method' ) ) {
		@@ -2200,6 +2203,7 @@ discard block
		block discarded – undo
2200	2203	* @param int $user_id
2201	2204	* @param string $token
2202	2205	* return bool
	2206	+ * @param boolean $is_master_user
2203	2207	*/
2204	2208	public static function update_user_token( $user_id, $token, $is_master_user ) {
2205	2209	// not designed for concurrent updates
		@@ -2644,7 +2648,7 @@ discard block
		block discarded – undo
2644	2648	*
2645	2649	* @param string $tag Tag as it appears in each module heading.
2646	2650	*
2647		- * @return mixed
	2651	+ * @return string
2648	2652	*/
2649	2653	public static function translate_module_tag( $tag ) {
2650	2654	return jetpack_get_module_i18n_tag( $tag );
		@@ -2816,8 +2820,8 @@ discard block
		block discarded – undo
2816	2820	* Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2817	2821	* is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2818	2822	*
2819		- * @param $string
2820		- * @return mixed
	2823	+ * @param string $string
	2824	+ * @return string\|null
2821	2825	*/
2822	2826	public static function alias_directories( $string ) {
2823	2827	// ABSPATH has a trailing slash.
		@@ -3077,6 +3081,9 @@ discard block
		block discarded – undo
3077	3081	return self::update_active_modules( $new );
3078	3082	}
3079	3083
	3084	+ /**
	3085	+ * @param string $module
	3086	+ */
3080	3087	public static function enable_module_configurable( $module ) {
3081	3088	$module = Jetpack::get_module_slug( $module );
3082	3089	add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
		@@ -3105,6 +3112,9 @@ discard block
		block discarded – undo
3105	3112	}
3106	3113
3107	3114	/* Installation */
	3115	+ /**
	3116	+ * @param string $message
	3117	+ */
3108	3118	public static function bail_on_activation( $message, $deactivate = true ) {
3109	3119	?>
3110	3120	<!doctype html>
		@@ -3839,7 +3849,7 @@ discard block
		block discarded – undo
3839	3849	* Add help to the Jetpack page
3840	3850	*
3841	3851	* @since Jetpack (1.2.3)
3842		- * @return false if not the Jetpack page
	3852	+ * @return false\|null if not the Jetpack page
3843	3853	*/
3844	3854	function admin_help() {
3845	3855	$current_screen = get_current_screen();
		@@ -4701,6 +4711,9 @@ discard block
		block discarded – undo
4701	4711	return $url;
4702	4712	}
4703	4713
	4714	+ /**
	4715	+ * @return string
	4716	+ */
4704	4717	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4705	4718	$actionurl = str_replace( '&', '&', $actionurl );
4706	4719	return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
		@@ -4760,6 +4773,7 @@ discard block
		block discarded – undo
4760	4773	/**
4761	4774	* Returns the requested Jetpack API URL
4762	4775	*
	4776	+ * @param string $relative_url
4763	4777	* @return string
4764	4778	*/
4765	4779	public static function api_url( $relative_url ) {
		@@ -4955,6 +4969,7 @@ discard block
		block discarded – undo
4955	4969	* Note these tokens are unique per call, NOT static per site for connecting.
4956	4970	*
4957	4971	* @since 2.6
	4972	+ * @param string $action
4958	4973	* @return array
4959	4974	*/
4960	4975	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
		@@ -5510,7 +5525,6 @@ discard block
		block discarded – undo
5510	5525	/**
5511	5526	* Report authentication status to the WP REST API.
5512	5527	*
5513		- * @param WP_Error\|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
5514	5528	* @return WP_Error\|boolean\|null {@see WP_JSON_Server::check_authentication}
5515	5529	*/
5516	5530	public function wp_rest_authentication_errors( $value ) {
		@@ -5520,6 +5534,10 @@ discard block
		block discarded – undo
5520	5534	return $this->rest_authentication_status;
5521	5535	}
5522	5536
	5537	+ /**
	5538	+ * @param integer $timestamp
	5539	+ * @param string $nonce
	5540	+ */
5523	5541	function add_nonce( $timestamp, $nonce ) {
5524	5542	global $wpdb;
5525	5543	static $nonces_used_this_request = array();
		@@ -5665,6 +5683,7 @@ discard block
		block discarded – undo
5665	5683	* @param string $key
5666	5684	* @param string $value
5667	5685	* @param bool $restate private
	5686	+ * @return string
5668	5687	*/
5669	5688	public static function state( $key = null, $value = null, $restate = false ) {
5670	5689	static $state = array();
		@@ -5721,6 +5740,9 @@ discard block
		block discarded – undo
5721	5740	Jetpack::state( null, null, true );
5722	5741	}
5723	5742
	5743	+ /**
	5744	+ * @param string $file
	5745	+ */
5724	5746	public static function check_privacy( $file ) {
5725	5747	static $is_site_publicly_accessible = null;
5726	5748
		@@ -5803,6 +5825,9 @@ discard block
		block discarded – undo
5803	5825	}
5804	5826	}
5805	5827
	5828	+ /**
	5829	+ * @param string $url
	5830	+ */
5806	5831	public static function staticize_subdomain( $url ) {
5807	5832
5808	5833	// Extract hostname from URL
		@@ -6358,9 +6383,7 @@ discard block
		block discarded – undo
6358	6383	*
6359	6384	* Attached to `style_loader_src` filter.
6360	6385	*
6361		- * @param string $tag The tag that would link to the external asset.
6362	6386	* @param string $handle The registered handle of the script in question.
6363		- * @param string $href The url of the asset in question.
6364	6387	*/
6365	6388	public static function set_suffix_on_min( $src, $handle ) {
6366	6389	if ( false === strpos( $src, '.min.css' ) ) {
		@@ -6547,8 +6570,8 @@ discard block
		block discarded – undo
6547	6570	* - Absolute URLs `http://domain.com/feh.png`
6548	6571	* - Domain root relative URLs `/feh.png`
6549	6572	*
6550		- * @param $css string: The raw CSS -- should be read in directly from the file.
6551		- * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
	6573	+ * @param string $css string: The raw CSS -- should be read in directly from the file.
	6574	+ * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6552	6575	*
6553	6576	* @return mixed\|string
6554	6577	*/
		@@ -6791,7 +6814,7 @@ discard block
		block discarded – undo
6791	6814	/**
6792	6815	* Stores and prints out domains to prefetch for page speed optimization.
6793	6816	*
6794		- * @param mixed $new_urls
	6817	+ * @param string[] $new_urls
6795	6818	*/
6796	6819	public static function dns_prefetch( $new_urls = null ) {
6797	6820	static $prefetch_urls = array();
		@@ -6847,7 +6870,6 @@ discard block
		block discarded – undo
6847	6870	}
6848	6871
6849	6872	/**
6850		- * @param mixed $result Value for the user's option
6851	6873	* @return mixed
6852	6874	*/
6853	6875	function get_user_option_meta_box_order_dashboard( $sorted ) {

Automattic / jetpack

Push — try/instant-search-rendering ( cde8b5...089ecc )

Status

Category

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