Jetpack_Tweet::jetpack_shortcode_tweet_gutenberg_script() - Code Metrics - Inspection of "Oops, forgot the closing parens." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — gutenberg/tweet-block ( 681794...6fbc6c )

by George

created 2017-08-07 18:38 UTC

jetpack_shortcode_tweet_gutenberg_script() B

↳ Parent: Jetpack_Tweet

Complexity

Conditions	1
Paths	1

Size

Total Lines	118
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	0
dl	0
loc	118
rs	8.2857
c	0
b	0
f	0

How to fix Long Method

<?php
/**
 * Tweet shortcode.
 * Params map to key value pairs, and all but tweet are optional:
 * tweet = id or permalink url* (Required)
 * align = none|left|right|center
 * width = number in pixels  example: width="300"
 * lang  =  en|fr|de|ko|etc...  language country code.
 * hide_thread = true | false **
 * hide_media  = true | false **
 *
 * Basic:
 * [tweet https://twitter.com/jack/statuses/20 width="350"]
 *
 * More parameters and another tweet syntax admitted:
 * [tweet tweet="https://twitter.com/jack/statuses/20" align="left" width="350" align="center" lang="es"]
 */

add_shortcode( 'tweet', array( 'Jetpack_Tweet', 'jetpack_tweet_shortcode' ) );
add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Tweet', 'enqueue_block_editor_assets' ) );

class Jetpack_Tweet {

	static $provider_args;
class A {
    var $property;
}

	/**
	 * Parse shortcode arguments and render its output.
	 *
	 * @since 4.5.0
	 *
	 * @param array $atts Shortcode parameters.
	 *
	 * @return string
	 */
	static public function jetpack_tweet_shortcode( $atts ) {

		$default_atts = array(
			'tweet'       => '',
			'align'       => 'none',
			'width'       => '',
			'lang'        => 'en',
			'hide_thread' => 'false',
			'hide_media'  => 'false',
		);

		$attr = shortcode_atts( $default_atts, $atts );

		self::$provider_args = $attr;

		// figure out the tweet id for the requested tweet
		// supporting both omitted attributes and tweet="tweet_id"
		// and supporting both an id and a URL
		if ( empty( $attr['tweet'] ) && ! empty( $atts[0] ) ) {
			$attr['tweet'] = $atts[0];
		}

		if ( ctype_digit( $attr['tweet'] ) ) {
			$id = 'https://twitter.com/jetpack/status/' . $attr['tweet'];
		} else {
			preg_match( '/^http(s|):\/\/twitter\.com(\/\#\!\/|\/)([a-zA-Z0-9_]{1,20})\/status(es)*\/(\d+)$/', $attr['tweet'], $urlbits );

			if ( isset( $urlbits[5] ) && intval( $urlbits[5] ) ) {
				$id = 'https://twitter.com/' . $urlbits[3] . '/status/' . intval( $urlbits[5] );
			} else {
				return '<!-- Invalid tweet id -->';
			}
		}

		// Add shortcode arguments to provider URL
		add_filter( 'oembed_fetch_url', array( 'Jetpack_Tweet', 'jetpack_tweet_url_extra_args' ), 10, 3 );

		// Fetch tweet
		$output = wp_oembed_get( $id, $atts );

		// Clean up filter
		remove_filter( 'oembed_fetch_url', array( 'Jetpack_Tweet', 'jetpack_tweet_url_extra_args' ), 10 );

		// Add Twitter widgets.js script to the footer.
		add_action( 'wp_footer', array( 'Jetpack_Tweet', 'jetpack_tweet_shortcode_script' ) );

		/** This action is documented in modules/widgets/social-media-icons.php */
		do_action( 'jetpack_bump_stats_extras', 'embeds', 'tweet' );

		return $output;
	}

	/**
	 * Adds parameters to URL used to fetch the tweet.
	 *
	 * @since 4.5.0
	 *
	 * @param string $provider URL of provider that supplies the tweet we're requesting.
	 * @param string $url      URL of tweet to embed.
	 * @param array  $args     Parameters supplied to shortcode and passed to wp_oembed_get
	 *
	 * @return string
	 */
	static public function jetpack_tweet_url_extra_args( $provider, $url, $args = array() ) {

		foreach ( self::$provider_args as $key => $value ) {
			switch ( $key ) {
				case 'align':
				case 'lang':
				case 'hide_thread':
				case 'hide_media':
					$provider = add_query_arg( $key, $value, $provider );
					break;
			}
		}

		// Disable script since we're enqueing it in our own way in the footer
		$provider = add_query_arg( 'omit_script', 'true', $provider );

		// Twitter doesn't support maxheight so don't send it
		$provider = remove_query_arg( 'maxheight', $provider );

		/**
		 * Filter the Twitter Partner ID.
		 *
		 * @module shortcodes
		 *
		 * @since 4.6.0
		 *
		 * @param string $partner_id Twitter partner ID.
		 */
		$partner = apply_filters( 'jetpack_twitter_partner_id', 'jetpack' );

		// Add Twitter partner ID to track embeds from Jetpack
		if ( ! empty( $partner ) ) {
			$provider = add_query_arg( 'partner', $partner, $provider );
		}

		return $provider;
	}

	/**
	 * Enqueue front end assets.
	 *
	 * @since 4.5.0
	 */
	static public function jetpack_tweet_shortcode_script() {

		if ( ! wp_script_is( 'twitter-widgets', 'registered' ) ) {
			wp_register_script( 'twitter-widgets', set_url_scheme( 'http://platform.twitter.com/widgets.js' ), array(), JETPACK__VERSION, true );
			wp_print_scripts( 'twitter-widgets' );
		}
	}

	static public function enqueue_block_editor_assets() {

		wp_register_script(
			'jetpack-shortcode-tweet-gutenberg',
			null,
			array( 'wp-blocks', 'wp-i18n', 'wp-element', 'shortcode' )
		);
		wp_enqueue_script( 'jetpack-shortcode-tweet-gutenberg' );

		ob_start();
		self::jetpack_shortcode_tweet_gutenberg_script();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
		$content = ob_get_clean();

		wp_script_add_data( 'jetpack-shortcode-tweet-gutenberg', 'data', $content );
	}

	static public function jetpack_shortcode_tweet_gutenberg_script() {

?>
// <script>
( function( wp ) {
	wp.blocks.registerBlockType( 'jetpack/tweet', {
		title: wp.i18n.__( 'Tweet', 'jetpack' ),
		icon: 'twitter',
		category: 'layout',

		attributes : {
			tweet : function ( node ) {
				var shortcode = wp.shortcode.next( 'tweet', node.innerText );
				if ( shortcode.attrs.named.tweet ) {
					return shortcode.attrs.named.tweet;
				}
				if ( shortcode.attrs.numeric[0] ) {
					return shortcode.attrs.numeric[0];
				}
				return null;
			},
			align : function ( node ) {
				var shortcode = wp.shortcode.next( 'tweet', node.innerText );
				if ( shortcode.attrs.named.align ) {
					return shortcode.attrs.named.align;
				}
				return 'none';
			},
			width : function ( node ) {
				var shortcode = wp.shortcode.next( 'tweet', node.innerText );
				if ( shortcode.attrs.named.width ) {
					return shortcode.attrs.named.width;
				}
				return '';
			},
			lang : function ( node ) {
				var shortcode = wp.shortcode.next( 'tweet', node.innerText );
				if ( shortcode.attrs.named.lang ) {
					return shortcode.attrs.named.lang;
				}
				return 'en';
			},
			hide_thread : function ( node ) {
				var shortcode = wp.shortcode.next( 'tweet', node.innerText );
				if ( shortcode.attrs.named.hide_thread ) {
					return shortcode.attrs.named.hide_thread;
				}
				return 'false';
			},
			hide_media : function ( node ) {
				var shortcode = wp.shortcode.next( 'tweet', node.innerText );
				if ( shortcode.attrs.named.hide_media ) {
					return shortcode.attrs.named.hide_media;
				}
				return 'false';
			}
		},

		edit : function( props ) {
			return wp.element.createElement(
				'input',
				{
					name : 'tweet',
					type : 'url',
					value : props.attributes.tweet,
					onChange: function( event ) {
						props.setAttributes({
							tweet: event.target.value
						});
					}
				},
				null
			);
		},

		save : function( props ) {
			var args = {
				tag     : 'tweet',
				attrs   : {
					named   : {},
					numeric : [
						props.attributes.tweet
					]
				}
			};

			// Populate optional attributes.
			if ( props.attributes.align && props.attributes.align !== 'none' ) {
				args.attrs.named.align = props.attributes.align;
			}
			if ( props.attributes.width && props.attributes.width !== '' ) {
				args.attrs.named.width = props.attributes.width;
			}
			if ( props.attributes.lang && props.attributes.lang !== 'en' ) {
				args.attrs.named.lang = props.attributes.lang;
			}
			if ( props.attributes.hide_thread && props.attributes.hide_thread !== 'none' ) {
				args.attrs.named.hide_thread = props.attributes.hide_thread;
			}
			if ( props.attributes.hide_media && props.attributes.hide_media !== 'none' ) {
				args.attrs.named.hide_media = props.attributes.hide_media;
			}

			if ( props.className ) {
				return wp.element.createElement(
					'div',
					{ className : props.className },
					wp.shortcode.string( args )
				);
			}

			return wp.shortcode.string( args );
		}

	} );
} )( window.wp );
// </script>
<?php
	}

} // class end


1			<?php
2			/**
3			* Tweet shortcode.
4			* Params map to key value pairs, and all but tweet are optional:
5			* tweet = id or permalink url* (Required)
6			* align = none\|left\|right\|center
7			* width = number in pixels example: width="300"
8			* lang = en\|fr\|de\|ko\|etc... language country code.
9			* hide_thread = true \| false **
10			* hide_media = true \| false **
11			*
12			* Basic:
13			* [tweet https://twitter.com/jack/statuses/20 width="350"]
14			*
15			* More parameters and another tweet syntax admitted:
16			* [tweet tweet="https://twitter.com/jack/statuses/20" align="left" width="350" align="center" lang="es"]
17			*/
18
19			add_shortcode( 'tweet', array( 'Jetpack_Tweet', 'jetpack_tweet_shortcode' ) );
20			add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Tweet', 'enqueue_block_editor_assets' ) );
21
22			class Jetpack_Tweet {
23
24			static $provider_args;
			0 ignored issues – show Coding Style introduced 2016-11-30 17:51 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$provider_args`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
25
26			/**
27			* Parse shortcode arguments and render its output.
28			*
29			* @since 4.5.0
30			*
31			* @param array $atts Shortcode parameters.
32			*
33			* @return string
34			*/
35			static public function jetpack_tweet_shortcode( $atts ) {
			0 ignored issues – show Coding Style introduced 2017-07-31 16:04 UTC by Report Bug Copy Issue Report As per PSR2, the `static` declaration should come after the visibility declaration. Loading history...
36			$default_atts = array(
37			'tweet' => '',
38			'align' => 'none',
39			'width' => '',
40			'lang' => 'en',
41			'hide_thread' => 'false',
42			'hide_media' => 'false',
43			);
44
45			$attr = shortcode_atts( $default_atts, $atts );
46
47			self::$provider_args = $attr;
48
49			// figure out the tweet id for the requested tweet
50			// supporting both omitted attributes and tweet="tweet_id"
51			// and supporting both an id and a URL
52			if ( empty( $attr['tweet'] ) && ! empty( $atts[0] ) ) {
53			$attr['tweet'] = $atts[0];
54			}
55
56			if ( ctype_digit( $attr['tweet'] ) ) {
57			$id = 'https://twitter.com/jetpack/status/' . $attr['tweet'];
58			} else {
59			preg_match( '/^http(s\|):\/\/twitter\.com(\/\#\!\/\|\/)([a-zA-Z0-9_]{1,20})\/status(es)*\/(\d+)$/', $attr['tweet'], $urlbits );
60
61			if ( isset( $urlbits[5] ) && intval( $urlbits[5] ) ) {
62			$id = 'https://twitter.com/' . $urlbits[3] . '/status/' . intval( $urlbits[5] );
63			} else {
64			return '<!-- Invalid tweet id -->';
65			}
66			}
67
68			// Add shortcode arguments to provider URL
69			add_filter( 'oembed_fetch_url', array( 'Jetpack_Tweet', 'jetpack_tweet_url_extra_args' ), 10, 3 );
70
71			// Fetch tweet
72			$output = wp_oembed_get( $id, $atts );
73
74			// Clean up filter
75			remove_filter( 'oembed_fetch_url', array( 'Jetpack_Tweet', 'jetpack_tweet_url_extra_args' ), 10 );
76
77			// Add Twitter widgets.js script to the footer.
78			add_action( 'wp_footer', array( 'Jetpack_Tweet', 'jetpack_tweet_shortcode_script' ) );
79
80			/** This action is documented in modules/widgets/social-media-icons.php */
81			do_action( 'jetpack_bump_stats_extras', 'embeds', 'tweet' );
82
83			return $output;
84			}
85
86			/**
87			* Adds parameters to URL used to fetch the tweet.
88			*
89			* @since 4.5.0
90			*
91			* @param string $provider URL of provider that supplies the tweet we're requesting.
92			* @param string $url URL of tweet to embed.
93			* @param array $args Parameters supplied to shortcode and passed to wp_oembed_get
94			*
95			* @return string
96			*/
97			static public function jetpack_tweet_url_extra_args( $provider, $url, $args = array() ) {
			0 ignored issues – show Coding Style introduced 2017-07-31 16:04 UTC by Report Bug Copy Issue Report As per PSR2, the `static` declaration should come after the visibility declaration. Loading history...
98			foreach ( self::$provider_args as $key => $value ) {
99			switch ( $key ) {
100			case 'align':
101			case 'lang':
102			case 'hide_thread':
103			case 'hide_media':
104			$provider = add_query_arg( $key, $value, $provider );
105			break;
106			}
107			}
108
109			// Disable script since we're enqueing it in our own way in the footer
110			$provider = add_query_arg( 'omit_script', 'true', $provider );
111
112			// Twitter doesn't support maxheight so don't send it
113			$provider = remove_query_arg( 'maxheight', $provider );
114
115			/**
116			* Filter the Twitter Partner ID.
117			*
118			* @module shortcodes
119			*
120			* @since 4.6.0
121			*
122			* @param string $partner_id Twitter partner ID.
123			*/
124			$partner = apply_filters( 'jetpack_twitter_partner_id', 'jetpack' );
125
126			// Add Twitter partner ID to track embeds from Jetpack
127			if ( ! empty( $partner ) ) {
128			$provider = add_query_arg( 'partner', $partner, $provider );
129			}
130
131			return $provider;
132			}
133
134			/**
135			* Enqueue front end assets.
136			*
137			* @since 4.5.0
138			*/
139			static public function jetpack_tweet_shortcode_script() {
			0 ignored issues – show Coding Style introduced 2017-07-31 16:04 UTC by Report Bug Copy Issue Report As per PSR2, the `static` declaration should come after the visibility declaration. Loading history...
140			if ( ! wp_script_is( 'twitter-widgets', 'registered' ) ) {
141			wp_register_script( 'twitter-widgets', set_url_scheme( 'http://platform.twitter.com/widgets.js' ), array(), JETPACK__VERSION, true );
142			wp_print_scripts( 'twitter-widgets' );
143			}
144			}
145
146			static public function enqueue_block_editor_assets() {
			0 ignored issues – show Coding Style introduced 2017-08-04 21:52 UTC by Report Bug Copy Issue Report As per PSR2, the `static` declaration should come after the visibility declaration. Loading history...
147			wp_register_script(
148			'jetpack-shortcode-tweet-gutenberg',
149			null,
150			array( 'wp-blocks', 'wp-i18n', 'wp-element', 'shortcode' )
151			);
152			wp_enqueue_script( 'jetpack-shortcode-tweet-gutenberg' );
153
154			ob_start();
155			self::jetpack_shortcode_tweet_gutenberg_script();
			0 ignored issues – show Unused Code introduced 2017-08-05 16:40 UTC by Report Bug Copy Issue Report The call to the method `Jetpack_Tweet::jetpack_s...weet_gutenberg_script()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
156			$content = ob_get_clean();
157
158			wp_script_add_data( 'jetpack-shortcode-tweet-gutenberg', 'data', $content );
159			}
160
161			static public function jetpack_shortcode_tweet_gutenberg_script() {
			0 ignored issues – show Coding Style introduced 2017-08-05 16:40 UTC by Report Bug Copy Issue Report As per PSR2, the `static` declaration should come after the visibility declaration. Loading history...
162			?>
163			// <script>
164			( function( wp ) {
165			wp.blocks.registerBlockType( 'jetpack/tweet', {
166			title: wp.i18n.__( 'Tweet', 'jetpack' ),
167			icon: 'twitter',
168			category: 'layout',
169
170			attributes : {
171			tweet : function ( node ) {
172			var shortcode = wp.shortcode.next( 'tweet', node.innerText );
173			if ( shortcode.attrs.named.tweet ) {
174			return shortcode.attrs.named.tweet;
175			}
176			if ( shortcode.attrs.numeric[0] ) {
177			return shortcode.attrs.numeric[0];
178			}
179			return null;
180			},
181			align : function ( node ) {
182			var shortcode = wp.shortcode.next( 'tweet', node.innerText );
183			if ( shortcode.attrs.named.align ) {
184			return shortcode.attrs.named.align;
185			}
186			return 'none';
187			},
188			width : function ( node ) {
189			var shortcode = wp.shortcode.next( 'tweet', node.innerText );
190			if ( shortcode.attrs.named.width ) {
191			return shortcode.attrs.named.width;
192			}
193			return '';
194			},
195			lang : function ( node ) {
196			var shortcode = wp.shortcode.next( 'tweet', node.innerText );
197			if ( shortcode.attrs.named.lang ) {
198			return shortcode.attrs.named.lang;
199			}
200			return 'en';
201			},
202			hide_thread : function ( node ) {
203			var shortcode = wp.shortcode.next( 'tweet', node.innerText );
204			if ( shortcode.attrs.named.hide_thread ) {
205			return shortcode.attrs.named.hide_thread;
206			}
207			return 'false';
208			},
209			hide_media : function ( node ) {
210			var shortcode = wp.shortcode.next( 'tweet', node.innerText );
211			if ( shortcode.attrs.named.hide_media ) {
212			return shortcode.attrs.named.hide_media;
213			}
214			return 'false';
215			}
216			},
217
218			edit : function( props ) {
219			return wp.element.createElement(
220			'input',
221			{
222			name : 'tweet',
223			type : 'url',
224			value : props.attributes.tweet,
225			onChange: function( event ) {
226			props.setAttributes({
227			tweet: event.target.value
228			});
229			}
230			},
231			null
232			);
233			},
234
235			save : function( props ) {
236			var args = {
237			tag : 'tweet',
238			attrs : {
239			named : {},
240			numeric : [
241			props.attributes.tweet
242			]
243			}
244			};
245
246			// Populate optional attributes.
247			if ( props.attributes.align && props.attributes.align !== 'none' ) {
248			args.attrs.named.align = props.attributes.align;
249			}
250			if ( props.attributes.width && props.attributes.width !== '' ) {
251			args.attrs.named.width = props.attributes.width;
252			}
253			if ( props.attributes.lang && props.attributes.lang !== 'en' ) {
254			args.attrs.named.lang = props.attributes.lang;
255			}
256			if ( props.attributes.hide_thread && props.attributes.hide_thread !== 'none' ) {
257			args.attrs.named.hide_thread = props.attributes.hide_thread;
258			}
259			if ( props.attributes.hide_media && props.attributes.hide_media !== 'none' ) {
260			args.attrs.named.hide_media = props.attributes.hide_media;
261			}
262
263			if ( props.className ) {
264			return wp.element.createElement(
265			'div',
266			{ className : props.className },
267			wp.shortcode.string( args )
268			);
269			}
270
271			return wp.shortcode.string( args );
272			}
273
274			} );
275			} )( window.wp );
276			// </script>
277			<?php
278			}
279
280			} // class end
281

Automattic / jetpack

Push — gutenberg/tweet-block ( 681794...6fbc6c )

jetpack_shortcode_tweet_gutenberg_script() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like