Jetpack_EU_Cookie_Law_Widget::update() - Code Metrics - Inspection of "WordAds: remove geolocation options from eu cookie..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/gdpr-ads-compliance ( 6d1e7f...65c5dd )

unknown

created 2018-04-30 21:19 UTC

Jetpack_EU_Cookie_Law_Widget::update() F

↳ Parent: Jetpack_EU_Cookie_Law_Widget

Complexity

Conditions	16
Paths	1536

Size

Total Lines	66
Code Lines	38

Duplication

Lines	8
Ratio	12.12 %

Importance

Changes

Metric	Value
cc	16
eloc	38
nc	1536
nop	2
dl	8
loc	66
rs	2.7057
c	0
b	0
f	0

How to fix Long Method Complexity

<?php

/**
 * Disable direct access/execution to/of the widget code.
 */
if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

if ( ! class_exists( 'Jetpack_EU_Cookie_Law_Widget' ) ) {
	/**
	 * EU Cookie Law Widget
	 *
	 * Display the EU Cookie Law banner in the bottom part of the screen.
	 */
	class Jetpack_EU_Cookie_Law_Widget extends WP_Widget {
		/**
		 * EU Cookie Law cookie name.
		 *
		 * @var string
		 */
		public static $cookie_name = 'eucookielaw';

		/**
		 * Default hide options.
		 *
		 * @var array
		 */
		private $hide_options = array(
			'button',
			'scroll',
			'time',
		);

		/**
		 * Default text options.
		 *
		 * @var array
		 */
		private $text_options = array(
			'default',
			'custom',
		);

		/**
		 * Default color scheme options.
		 *
		 * @var array
		 */
		private $color_scheme_options = array(
			'default',
			'negative',
		);

		/**
		 * Default policy URL options.
		 *
		 * @var array
		 */
		private $policy_url_options = array(
			'default',
			'custom',
		);

		/**
		 * Constructor.
		 */
		function __construct() {
			parent::__construct(
				'eu_cookie_law_widget',
				/** This filter is documented in modules/widgets/facebook-likebox.php */
				apply_filters( 'jetpack_widget_name', esc_html__( 'EU Cookie Law Banner', 'jetpack' ) ),
				array(
					'description' => esc_html__( 'Display a banner for compliance with the EU Cookie Law.', 'jetpack' ),
					'customize_selective_refresh' => true,
				),
				array()
			);

			if ( is_active_widget( false, false, $this->id_base ) || is_customize_preview() ) {
				add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_frontend_scripts' ) );
			}
		}

		/**
		 * Enqueue scripts and styles.
		 */
		function enqueue_frontend_scripts() {
			wp_enqueue_style( 'eu-cookie-law-style', plugins_url( 'eu-cookie-law/style.css', __FILE__ ), array(), '20170403' );
			wp_enqueue_script(
				'eu-cookie-law-script',
				Jetpack::get_file_url_for_environment(
					'_inc/build/widgets/eu-cookie-law/eu-cookie-law.min.js',
					'modules/widgets/eu-cookie-law/eu-cookie-law.js'
				),
				array( 'jquery' ),
				'20170404',
				true
			);
		}

		/**
		 * Return an associative array of default values.
		 *
		 * These values are used in new widgets.
		 *
		 * @return array Default values for the widget options.
		 */
		public function defaults() {
			return array(
				'hide'               => $this->hide_options[0],
				'hide-timeout'       => 30,
				'consent-expiration' => 180,
				'text'               => $this->text_options[0],
				'customtext'         => '',
				'color-scheme'       => $this->color_scheme_options[0],
				'policy-url'         => $this->policy_url_options[0],
				'default-policy-url' => 'https://jetpack.com/support/cookies/',
				'custom-policy-url'  => '',
				'policy-link-text'   => esc_html__( 'Our Cookie Policy', 'jetpack' ),
				'button'             => esc_html__( 'Close and accept', 'jetpack' ),
				'default-text'       => esc_html__( 'Privacy & Cookies: This site uses cookies.', 'jetpack' ),
			);
		}

		/**
		 * Front-end display of the widget.
		 *
		 * @param array $args     Widget arguments.
		 * @param array $instance Saved values from database.
		 */
		public function widget( $args, $instance ) {
			$instance = wp_parse_args( $instance, $this->defaults() );

			$classes = array();
			$classes[] = 'hide-on-' . esc_attr( $instance['hide'] );
			if ( 'negative' === $instance['color-scheme'] ) {
				$classes[] = 'negative';
			}
			if ( Jetpack::is_module_active( 'wordads' ) ) {
				$classes[] = 'ads-active';
			}

			echo $args['before_widget'];
			require( dirname( __FILE__ ) . '/eu-cookie-law/widget.php' );
			echo $args['after_widget'];
			/** This action is already documented in modules/widgets/gravatar-profile.php */
			do_action( 'jetpack_stats_extra', 'widget_view', 'eu_cookie_law' );
		}

		/**
		 * Back-end widget form.
		 *
		 * @param array $instance Previously saved values from database.
		 */
		public function form( $instance ) {
			$instance = wp_parse_args( $instance, $this->defaults() );
			require( dirname( __FILE__ ) . '/eu-cookie-law/form.php' );
		}

		/**
		 * Sanitize widget form values as they are saved.
		 *
		 * @param  array $new_instance Values just sent to be saved.
		 * @param  array $old_instance Previously saved values from database.
		 * @return array Updated safe values to be saved.
		 */
		public function update( $new_instance, $old_instance ) {
			$instance = array();
			$defaults = $this->defaults();

			$instance['hide']           = $this->filter_value( $new_instance['hide'], $this->hide_options );
			$instance['text']           = $this->filter_value( $new_instance['text'], $this->text_options );
			$instance['color-scheme']   = $this->filter_value( $new_instance['color-scheme'], $this->color_scheme_options );
			$instance['policy-url']     = $this->filter_value( $new_instance['policy-url'], $this->policy_url_options );

			if ( isset( $new_instance['hide-timeout'] ) ) {
				// Time can be a value between 3 and 1000 seconds.
				$instance['hide-timeout'] = min( 1000, max( 3, intval( $new_instance['hide-timeout'] ) ) );
			}

			if ( isset( $new_instance['consent-expiration'] ) ) {
				// Time can be a value between 1 and 365 days.
				$instance['consent-expiration'] = min( 365, max( 1, intval( $new_instance['consent-expiration'] ) ) );
			}

			if ( isset( $new_instance['customtext'] ) ) {
				$instance['customtext'] = mb_substr( wp_kses( $new_instance['customtext'], array() ), 0, 4096 );
			} else {
				$instance['text'] = $this->text_options[0];
			}

			if ( isset( $new_instance['policy-url'] ) ) {
				$instance['policy-url'] = 'custom' === $new_instance['policy-url']
					? 'custom'
					: 'default';
			} else {
				$instance['policy-url'] = $this->policy_url_options[0];
			}

			if ( 'custom' === $instance['policy-url'] && isset( $new_instance['custom-policy-url'] ) ) {
				$instance['custom-policy-url'] = esc_url( $new_instance['custom-policy-url'], array( 'http', 'https' ) );

				if ( strlen( $instance['custom-policy-url'] ) < 10 ) {
					unset( $instance['custom-policy-url'] );
					global $wp_customize;
					if ( ! isset( $wp_customize ) ) {
						$instance['policy-url'] = $this->policy_url_options[0];
					}
				}
			}

			if ( isset( $new_instance['policy-link-text'] ) ) {
				$instance['policy-link-text'] = trim( mb_substr( wp_kses( $new_instance['policy-link-text'], array() ), 0, 100 ) );
			}

			if ( empty( $instance['policy-link-text'] ) || $instance['policy-link-text'] == $defaults['policy-link-text'] ) {
				unset( $instance['policy-link-text'] );
			}

			if ( isset( $new_instance['button'] ) ) {
				$instance['button'] = trim( mb_substr( wp_kses( $new_instance['button'], array() ), 0, 100 ) );
			}

			if ( empty( $instance['button'] ) || $instance['button'] == $defaults['button'] ) {
				unset( $instance['button'] );
			}

			// Show the banner again if a setting has been changed.
			setcookie( self::$cookie_name, '', time() - 86400, '/' );

			return $instance;
		}

		/**
		 * Check if the value is allowed and not empty.
		 *
		 * @param  string $value Value to check.
		 * @param  array  $allowed Array of allowed values.
		 *
		 * @return string $value if pass the check or first value from allowed values.
		 */
		function filter_value( $value, $allowed = array() ) {
			$allowed = (array) $allowed;
			if ( empty( $value ) || ( ! empty( $allowed ) && ! in_array( $value, $allowed ) ) ) {
				$value = $allowed[0];
			}
			return $value;
		}
	}

	// Register Jetpack_EU_Cookie_Law_Widget widget.
	function jetpack_register_eu_cookie_law_widget() {
		register_widget( 'Jetpack_EU_Cookie_Law_Widget' );
	};

	add_action( 'widgets_init', 'jetpack_register_eu_cookie_law_widget' );
}


1		<?php
2
3		/**
4		* Disable direct access/execution to/of the widget code.
5		*/
6		if ( ! defined( 'ABSPATH' ) ) {
7		exit;
8		}
9
10		if ( ! class_exists( 'Jetpack_EU_Cookie_Law_Widget' ) ) {
11		/**
12		* EU Cookie Law Widget
13		*
14		* Display the EU Cookie Law banner in the bottom part of the screen.
15		*/
16		class Jetpack_EU_Cookie_Law_Widget extends WP_Widget {
17		/**
18		* EU Cookie Law cookie name.
19		*
20		* @var string
21		*/
22		public static $cookie_name = 'eucookielaw';
23
24		/**
25		* Default hide options.
26		*
27		* @var array
28		*/
29		private $hide_options = array(
30		'button',
31		'scroll',
32		'time',
33		);
34
35		/**
36		* Default text options.
37		*
38		* @var array
39		*/
40		private $text_options = array(
41		'default',
42		'custom',
43		);
44
45		/**
46		* Default color scheme options.
47		*
48		* @var array
49		*/
50		private $color_scheme_options = array(
51		'default',
52		'negative',
53		);
54
55		/**
56		* Default policy URL options.
57		*
58		* @var array
59		*/
60		private $policy_url_options = array(
61		'default',
62		'custom',
63		);
64
65		/**
66		* Constructor.
67		*/
68		function __construct() {
69		parent::__construct(
70		'eu_cookie_law_widget',
71		/** This filter is documented in modules/widgets/facebook-likebox.php */
72		apply_filters( 'jetpack_widget_name', esc_html__( 'EU Cookie Law Banner', 'jetpack' ) ),
73		array(
74		'description' => esc_html__( 'Display a banner for compliance with the EU Cookie Law.', 'jetpack' ),
75		'customize_selective_refresh' => true,
76		),
77		array()
78		);
79
80	View Code Duplication	if ( is_active_widget( false, false, $this->id_base ) \|\| is_customize_preview() ) {
81		add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_frontend_scripts' ) );
82		}
83		}
84
85		/**
86		* Enqueue scripts and styles.
87		*/
88		function enqueue_frontend_scripts() {
89		wp_enqueue_style( 'eu-cookie-law-style', plugins_url( 'eu-cookie-law/style.css', __FILE__ ), array(), '20170403' );
90		wp_enqueue_script(
91		'eu-cookie-law-script',
92		Jetpack::get_file_url_for_environment(
93		'_inc/build/widgets/eu-cookie-law/eu-cookie-law.min.js',
94		'modules/widgets/eu-cookie-law/eu-cookie-law.js'
95		),
96		array( 'jquery' ),
97		'20170404',
98		true
99		);
100		}
101
102		/**
103		* Return an associative array of default values.
104		*
105		* These values are used in new widgets.
106		*
107		* @return array Default values for the widget options.
108		*/
109		public function defaults() {
110		return array(
111		'hide' => $this->hide_options[0],
112		'hide-timeout' => 30,
113		'consent-expiration' => 180,
114		'text' => $this->text_options[0],
115		'customtext' => '',
116		'color-scheme' => $this->color_scheme_options[0],
117		'policy-url' => $this->policy_url_options[0],
118		'default-policy-url' => 'https://jetpack.com/support/cookies/',
119		'custom-policy-url' => '',
120		'policy-link-text' => esc_html__( 'Our Cookie Policy', 'jetpack' ),
121		'button' => esc_html__( 'Close and accept', 'jetpack' ),
122		'default-text' => esc_html__( 'Privacy & Cookies: This site uses cookies.', 'jetpack' ),
123		);
124		}
125
126		/**
127		* Front-end display of the widget.
128		*
129		* @param array $args Widget arguments.
130		* @param array $instance Saved values from database.
131		*/
132		public function widget( $args, $instance ) {
133		$instance = wp_parse_args( $instance, $this->defaults() );
134
135		$classes = array();
136		$classes[] = 'hide-on-' . esc_attr( $instance['hide'] );
137		if ( 'negative' === $instance['color-scheme'] ) {
138		$classes[] = 'negative';
139		}
140		if ( Jetpack::is_module_active( 'wordads' ) ) {
141		$classes[] = 'ads-active';
142		}
143
144		echo $args['before_widget'];
145		require( dirname( __FILE__ ) . '/eu-cookie-law/widget.php' );
146		echo $args['after_widget'];
147		/** This action is already documented in modules/widgets/gravatar-profile.php */
148		do_action( 'jetpack_stats_extra', 'widget_view', 'eu_cookie_law' );
149		}
150
151		/**
152		* Back-end widget form.
153		*
154		* @param array $instance Previously saved values from database.
155		*/
156		public function form( $instance ) {
157		$instance = wp_parse_args( $instance, $this->defaults() );
158		require( dirname( __FILE__ ) . '/eu-cookie-law/form.php' );
159		}
160
161		/**
162		* Sanitize widget form values as they are saved.
163		*
164		* @param array $new_instance Values just sent to be saved.
165		* @param array $old_instance Previously saved values from database.
166		* @return array Updated safe values to be saved.
167		*/
168		public function update( $new_instance, $old_instance ) {
169		$instance = array();
170		$defaults = $this->defaults();
171
172		$instance['hide'] = $this->filter_value( $new_instance['hide'], $this->hide_options );
173		$instance['text'] = $this->filter_value( $new_instance['text'], $this->text_options );
174		$instance['color-scheme'] = $this->filter_value( $new_instance['color-scheme'], $this->color_scheme_options );
175		$instance['policy-url'] = $this->filter_value( $new_instance['policy-url'], $this->policy_url_options );
176
177	View Code Duplication	if ( isset( $new_instance['hide-timeout'] ) ) {
178		// Time can be a value between 3 and 1000 seconds.
179		$instance['hide-timeout'] = min( 1000, max( 3, intval( $new_instance['hide-timeout'] ) ) );
180		}
181
182	View Code Duplication	if ( isset( $new_instance['consent-expiration'] ) ) {
183		// Time can be a value between 1 and 365 days.
184		$instance['consent-expiration'] = min( 365, max( 1, intval( $new_instance['consent-expiration'] ) ) );
185		}
186
187		if ( isset( $new_instance['customtext'] ) ) {
188		$instance['customtext'] = mb_substr( wp_kses( $new_instance['customtext'], array() ), 0, 4096 );
189		} else {
190		$instance['text'] = $this->text_options[0];
191		}
192
193		if ( isset( $new_instance['policy-url'] ) ) {
194		$instance['policy-url'] = 'custom' === $new_instance['policy-url']
195		? 'custom'
196		: 'default';
197		} else {
198		$instance['policy-url'] = $this->policy_url_options[0];
199		}
200
201		if ( 'custom' === $instance['policy-url'] && isset( $new_instance['custom-policy-url'] ) ) {
202		$instance['custom-policy-url'] = esc_url( $new_instance['custom-policy-url'], array( 'http', 'https' ) );
203
204		if ( strlen( $instance['custom-policy-url'] ) < 10 ) {
205		unset( $instance['custom-policy-url'] );
206		global $wp_customize;
207		if ( ! isset( $wp_customize ) ) {
208		$instance['policy-url'] = $this->policy_url_options[0];
209		}
210		}
211		}
212
213		if ( isset( $new_instance['policy-link-text'] ) ) {
214		$instance['policy-link-text'] = trim( mb_substr( wp_kses( $new_instance['policy-link-text'], array() ), 0, 100 ) );
215		}
216
217		if ( empty( $instance['policy-link-text'] ) \|\| $instance['policy-link-text'] == $defaults['policy-link-text'] ) {
218		unset( $instance['policy-link-text'] );
219		}
220
221		if ( isset( $new_instance['button'] ) ) {
222		$instance['button'] = trim( mb_substr( wp_kses( $new_instance['button'], array() ), 0, 100 ) );
223		}
224
225		if ( empty( $instance['button'] ) \|\| $instance['button'] == $defaults['button'] ) {
226		unset( $instance['button'] );
227		}
228
229		// Show the banner again if a setting has been changed.
230		setcookie( self::$cookie_name, '', time() - 86400, '/' );
231
232		return $instance;
233		}
234
235		/**
236		* Check if the value is allowed and not empty.
237		*
238		* @param string $value Value to check.
239		* @param array $allowed Array of allowed values.
240		*
241		* @return string $value if pass the check or first value from allowed values.
242		*/
243		function filter_value( $value, $allowed = array() ) {
244		$allowed = (array) $allowed;
245		if ( empty( $value ) \|\| ( ! empty( $allowed ) && ! in_array( $value, $allowed ) ) ) {
246		$value = $allowed[0];
247		}
248		return $value;
249		}
250		}
251
252		// Register Jetpack_EU_Cookie_Law_Widget widget.
253		function jetpack_register_eu_cookie_law_widget() {
254		register_widget( 'Jetpack_EU_Cookie_Law_Widget' );
255		};
256
257		add_action( 'widgets_init', 'jetpack_register_eu_cookie_law_widget' );
258		}
259

Automattic / jetpack

Push — add/gdpr-ads-compliance ( 6d1e7f...65c5dd )

Jetpack_EU_Cookie_Law_Widget::update() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like