Jetpack_EU_Cookie_Law_Widget::update() - Code Metrics - Inspection of "Merge branch 'master' into add/docker-env-vars" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/docker-env-vars ( 4a8926...023c1d )

unknown

created 2018-04-02 17:51 UTC

Jetpack_EU_Cookie_Law_Widget::update() F

↳ Parent: Jetpack_EU_Cookie_Law_Widget

Complexity

Conditions	15
Paths	768

Size

Total Lines	61
Code Lines	36

Duplication

Lines	6
Ratio	9.84 %

Importance

Changes

Metric	Value
cc	15
eloc	36
nc	768
nop	2
dl	6
loc	61
rs	3.2786
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';

		/**
		 * EU Cookie Law cookie validity (30 days).
		 *
		 * @var int
		 */
		public static $cookie_validity = 2592000;

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

Automattic / jetpack

Push — add/docker-env-vars ( 4a8926...023c1d )

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