Wordlift_Timeline_Shortcode::render() - Code Metrics - Inspection of "fix navigator not loading and reapplying links to..." - insideout10/wordlift-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6f9ae7...b9bf14 )

by David

created 2016-10-23 06:01 UTC

Wordlift_Timeline_Shortcode::render() C

↳ Parent: Wordlift_Timeline_Shortcode

Complexity

Conditions	9
Paths	8

Size

Total Lines	78
Code Lines	52

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	9
eloc	52
nc	8
nop	1
dl	0
loc	78
rs	5.7191
c	0
b	0
f	0

How to fix Long Method

<?php

/**
 * The wl_timeline shortcode displays an interactive timeline of events bound to the current post.
 *
 * @since 3.1.0
 */
class Wordlift_Timeline_Shortcode extends Wordlift_Shortcode {

	const SHORTCODE = 'wl_timeline';

	/**
	 * The list of locales supported by TimelineJS (correspond to the list of
	 * files in the locale subfolder).
	 *
	 * @since 3.7.0
	 * @var array An array of two-letters language codes.
	 */
	private static $supported_locales = array(
		'ur',
		'uk',
		'tr',
		'tl',
		'th',
		'te',
		'ta',
		'sv',
		'sr',
		'sl',
		'sk',
		'si',
		'ru',
		'ro',
		'rm',
		'pt',
		'pl',
		'no',
		'nl',
		'ne',
		'ms',
		'lv',
		'lt',
		'lb',
		'ko',
		'ka',
		'ja',
		'iw',
		'it',
		'is',
		'id',
		'hy',
		'hu',
		'hr',
		'hi',
		'he',
		'gl',
		'ga',
		'fy',
		'fr',
		'fo',
		'fi',
		'fa',
		'eu',
		'et',
		'es',
		'eo',
		'en',
		'el',
		'de',
		'da',
		'cz',
		'ca',
		'bg',
		'be',
		'ar',
		'af'
	);

	/**
	 * The Log service.
	 *
	 * @since 3.1.0
	 * @access private
	 * @var \Wordlift_Log_Service $log_service The Log service.
	 */
	private $log_service;

	/**
	 * Create a Wordlift_Timeline_Shortcode instance.
	 *
	 * @since 3.1.0
	 */
	public function __construct() {
		parent::__construct();

		$this->log_service = Wordlift_Log_Service::get_logger( 'Wordlift_Timeline_Shortcode' );

	}

	/**
	 * Renders the Timeline.
	 *
	 * @since 3.1.0
	 *
	 * @param array $atts An array of shortcode attributes.
	 *
	 * @return string The rendered HTML.
	 */
	public function render( $atts ) {

		//extract attributes and set default values
		$settings = shortcode_atts( array(
			'debug'                            => defined( 'WP_DEBUG' ) && WP_DEBUG,
			'height'                           => NULL,
			'width'                            => NULL,
			'is_embed'                         => FALSE,
			'hash_bookmark'                    => FALSE,
			'default_bg_color'                 => 'white',
			'scale_factor'                     => 2,
			'initial_zoom'                     => NULL,
			'zoom_sequence'                    => '[0.5, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]',
			'timenav_position'                 => 'bottom',
			'optimal_tick_width'               => 100,
			'base_class'                       => 'tl-timeline',
			'timenav_height'                   => 150,
			'timenav_height_percentage'        => NULL,
			'timenav_mobile_height_percentage' => 40,
			'timenav_height_min'               => 150,
			'marker_height_min'                => 30,
			'marker_width_min'                 => 100,
			'marker_padding'                   => 5,
			'start_at_slide'                   => 0,
			'start_at_end'                     => FALSE,
			'menubar_height'                   => 0,
			'use_bc'                           => FALSE,
			'duration'                         => 1000,
			'ease'                             => 'TL.Ease.easeInOutQuint',
			'slide_default_fade'               => '0%',
			'language'                         => $this->get_locale(),
			'ga_property_id'                   => NULL,
			'track_events'                     => "['back_to_start','nav_next','nav_previous','zoom_in','zoom_out']",
			'global'                           => FALSE,
			// The following settings are unrelated to TimelineJS script.
			'display_images_as'                => 'media',
			'excerpt_length'                   => 55,
		), $atts );

		// Load the TimelineJS stylesheets and scripts.
		wp_enqueue_style( 'timelinejs', dirname( plugin_dir_url( __FILE__ ) ) . '/timelinejs/css/timeline.css' );
		wp_enqueue_script( 'timelinejs', dirname( plugin_dir_url( __FILE__ ) ) . '/timelinejs/js/timeline' . ( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ? '-min' : '' ) . '.js' );

		// Enqueue the scripts for the timeline.
		$this->enqueue_scripts();

		// Provide the script with options.
		wp_localize_script( 'timelinejs', 'wl_timeline_params', array(
			'ajax_url'          => admin_url( 'admin-ajax.php' ),
			// TODO: this parameter is already provided by WP
			'action'            => 'wl_timeline',
			// These settings apply to our wl_timeline AJAX endpoint.
			'display_images_as' => $settings['display_images_as'],
			'excerpt_length'    => $settings['excerpt_length'],
			// These settings apply to the timeline javascript client.
			'settings'          => array_filter( $settings, function ( $value ) {
				// Do not set NULL values.
				return ( NULL !== $value );
			} )
		) );

		// Get the current post id or set null if global is set to true.
		$post_id = ( $settings['global'] ? NULL : get_the_ID() );

		// Escaping atts.
		$style        = sprintf( 'style="%s%s"', isset( $settings['width'] ) ? "width:{$settings['width']};" : '', isset( $settings['height'] ) ? "height:{$settings['height']};" : '' );
		$data_post_id = ( isset( $post_id ) ? "data-post-id='$post_id'" : '' );

		// Generate a unique ID for this timeline.
		$element_id = uniqid( 'wl-timeline-' );

		if ( WP_DEBUG ) {
			$this->log_service->trace( "Creating a timeline widget [ element id :: $element_id ][ post id :: $post_id ]" );
		}

		// Building template.
		return sprintf( '<div class="wl-timeline-container" %s><div class="wl-timeline" id="%s" %s></div></div>', $style, $element_id, $data_post_id );
	}

	/**
	 * Return the locale for the TimelineJS according to WP's configured locale and
	 * support TimelineJS locales. If WP's locale is not supported, english is used.
	 *
	 * @since 3.7.0
	 * @return string The locale (2 letters code).
	 */
	private function get_locale() {

		// Get the first 2 letters.
		$locale = substr( get_locale(), 0, 2 );

		// Check that the specified locale is supported otherwise use English.
		return in_array( $locale, self::$supported_locales ) ? $locale : 'en';
	}

}


1			<?php
2
3			/**
4			* The wl_timeline shortcode displays an interactive timeline of events bound to the current post.
5			*
6			* @since 3.1.0
7			*/
8			class Wordlift_Timeline_Shortcode extends Wordlift_Shortcode {
9
10			const SHORTCODE = 'wl_timeline';
11
12			/**
13			* The list of locales supported by TimelineJS (correspond to the list of
14			* files in the locale subfolder).
15			*
16			* @since 3.7.0
17			* @var array An array of two-letters language codes.
18			*/
19			private static $supported_locales = array(
20			'ur',
21			'uk',
22			'tr',
23			'tl',
24			'th',
25			'te',
26			'ta',
27			'sv',
28			'sr',
29			'sl',
30			'sk',
31			'si',
32			'ru',
33			'ro',
34			'rm',
35			'pt',
36			'pl',
37			'no',
38			'nl',
39			'ne',
40			'ms',
41			'lv',
42			'lt',
43			'lb',
44			'ko',
45			'ka',
46			'ja',
47			'iw',
48			'it',
49			'is',
50			'id',
51			'hy',
52			'hu',
53			'hr',
54			'hi',
55			'he',
56			'gl',
57			'ga',
58			'fy',
59			'fr',
60			'fo',
61			'fi',
62			'fa',
63			'eu',
64			'et',
65			'es',
66			'eo',
67			'en',
68			'el',
69			'de',
70			'da',
71			'cz',
72			'ca',
73			'bg',
74			'be',
75			'ar',
76			'af'
77			);
78
79			/**
80			* The Log service.
81			*
82			* @since 3.1.0
83			* @access private
84			* @var \Wordlift_Log_Service $log_service The Log service.
85			*/
86			private $log_service;
87
88			/**
89			* Create a Wordlift_Timeline_Shortcode instance.
90			*
91			* @since 3.1.0
92			*/
93			public function __construct() {
94			parent::__construct();
95
96			$this->log_service = Wordlift_Log_Service::get_logger( 'Wordlift_Timeline_Shortcode' );
97
98			}
99
100			/**
101			* Renders the Timeline.
102			*
103			* @since 3.1.0
104			*
105			* @param array $atts An array of shortcode attributes.
106			*
107			* @return string The rendered HTML.
108			*/
109			public function render( $atts ) {
110
111			//extract attributes and set default values
112			$settings = shortcode_atts( array(
113			'debug' => defined( 'WP_DEBUG' ) && WP_DEBUG,
114			'height' => NULL,
115			'width' => NULL,
116			'is_embed' => FALSE,
117			'hash_bookmark' => FALSE,
118			'default_bg_color' => 'white',
119			'scale_factor' => 2,
120			'initial_zoom' => NULL,
121			'zoom_sequence' => '[0.5, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]',
122			'timenav_position' => 'bottom',
123			'optimal_tick_width' => 100,
124			'base_class' => 'tl-timeline',
125			'timenav_height' => 150,
126			'timenav_height_percentage' => NULL,
127			'timenav_mobile_height_percentage' => 40,
128			'timenav_height_min' => 150,
129			'marker_height_min' => 30,
130			'marker_width_min' => 100,
131			'marker_padding' => 5,
132			'start_at_slide' => 0,
133			'start_at_end' => FALSE,
134			'menubar_height' => 0,
135			'use_bc' => FALSE,
136			'duration' => 1000,
137			'ease' => 'TL.Ease.easeInOutQuint',
138			'slide_default_fade' => '0%',
139			'language' => $this->get_locale(),
140			'ga_property_id' => NULL,
141			'track_events' => "['back_to_start','nav_next','nav_previous','zoom_in','zoom_out']",
142			'global' => FALSE,
143			// The following settings are unrelated to TimelineJS script.
144			'display_images_as' => 'media',
145			'excerpt_length' => 55,
146			), $atts );
147
148			// Load the TimelineJS stylesheets and scripts.
149			wp_enqueue_style( 'timelinejs', dirname( plugin_dir_url( __FILE__ ) ) . '/timelinejs/css/timeline.css' );
150			wp_enqueue_script( 'timelinejs', dirname( plugin_dir_url( __FILE__ ) ) . '/timelinejs/js/timeline' . ( ! defined( 'SCRIPT_DEBUG' ) \|\| ! SCRIPT_DEBUG ? '-min' : '' ) . '.js' );
151
152			// Enqueue the scripts for the timeline.
153			$this->enqueue_scripts();
154
155			// Provide the script with options.
156			wp_localize_script( 'timelinejs', 'wl_timeline_params', array(
157			'ajax_url' => admin_url( 'admin-ajax.php' ),
158			// TODO: this parameter is already provided by WP
159			'action' => 'wl_timeline',
160			// These settings apply to our wl_timeline AJAX endpoint.
161			'display_images_as' => $settings['display_images_as'],
162			'excerpt_length' => $settings['excerpt_length'],
163			// These settings apply to the timeline javascript client.
164			'settings' => array_filter( $settings, function ( $value ) {
165			// Do not set NULL values.
166			return ( NULL !== $value );
167			} )
168			) );
169
170			// Get the current post id or set null if global is set to true.
171			$post_id = ( $settings['global'] ? NULL : get_the_ID() );
172
173			// Escaping atts.
174			$style = sprintf( 'style="%s%s"', isset( $settings['width'] ) ? "width:{$settings['width']};" : '', isset( $settings['height'] ) ? "height:{$settings['height']};" : '' );
175			$data_post_id = ( isset( $post_id ) ? "data-post-id='$post_id'" : '' );
176
177			// Generate a unique ID for this timeline.
178			$element_id = uniqid( 'wl-timeline-' );
179
180			if ( WP_DEBUG ) {
181			$this->log_service->trace( "Creating a timeline widget [ element id :: $element_id ][ post id :: $post_id ]" );
182			}
183
184			// Building template.
185			return sprintf( '<div class="wl-timeline-container" %s><div class="wl-timeline" id="%s" %s></div></div>', $style, $element_id, $data_post_id );
186			}
187
188			/**
189			* Return the locale for the TimelineJS according to WP's configured locale and
190			* support TimelineJS locales. If WP's locale is not supported, english is used.
191			*
192			* @since 3.7.0
193			* @return string The locale (2 letters code).
194			*/
195			private function get_locale() {
196
197			// Get the first 2 letters.
198			$locale = substr( get_locale(), 0, 2 );
199
200			// Check that the specified locale is supported otherwise use English.
201			return in_array( $locale, self::$supported_locales ) ? $locale : 'en';
202			}
203
204			}
205

insideout10 / wordlift-plugin

Push — master ( 6f9ae7...b9bf14 )

Wordlift_Timeline_Shortcode::render() C

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like