Jetpack_Upcoming_Events_Widget::__construct() - Code Metrics - Inspection of "New build" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — branch-4.6-built ( 825187 )

unknown

created 2017-02-01 01:03 UTC

Jetpack_Upcoming_Events_Widget::__construct() A

↳ Parent: Jetpack_Upcoming_Events_Widget

Complexity

Conditions	2
Paths	2

Size

Total Lines	14
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	9
nc	2
nop	0
dl	0
loc	14
rs	9.4285
c	0
b	0
f	0

<?php

class Jetpack_Upcoming_Events_Widget extends WP_Widget {
	function __construct() {
		parent::__construct(
			'upcoming_events_widget',
			/** This filter is documented in modules/widgets/facebook-likebox.php */
			apply_filters( 'jetpack_widget_name', __( 'Upcoming Events', 'jetpack' ) ),
			array(
				'description' => __( 'Display upcoming events from an iCalendar feed.', 'jetpack' ),
				'customize_selective_refresh' => true,
			)
		);
		if ( is_active_widget( false, false, $this->id_base ) ) {
			add_action( 'wp_head', array( $this, 'css' ) );
		}
	}

	function css() {
?>
<style type="text/css">
.upcoming-events li {
	margin-bottom: 10px;
}
.upcoming-events li span {
	display: block;
}
</style>
<?php
	}

	function form( $instance ) {
		$defaults = array(
			'title' => __( 'Upcoming Events', 'jetpack' ),
			'feed-url' => '',
			'count' => 3
		);
		$instance = array_merge( $defaults, (array) $instance );
?>

		<p>
		<label for="<?php echo $this->get_field_id( 'title' ); ?>"><?php _e( 'Title:', 'jetpack' ); ?></label>
		<input class="widefat" id="<?php echo $this->get_field_id( 'title' ); ?>" name="<?php echo $this->get_field_name( 'title' ); ?>" type="text" value="<?php echo esc_attr( $instance['title'] ); ?>" />
		</p>

		<p>
		<label for="<?php echo $this->get_field_id( 'feed-url' ); ?>"><?php _e( 'iCalendar Feed URL:', 'jetpack' ); ?></label>
		<input class="widefat" id="<?php echo $this->get_field_id( 'feed-url' ); ?>" name="<?php echo $this->get_field_name( 'feed-url' ); ?>" type="text" value="<?php echo esc_attr( $instance['feed-url'] ); ?>" />
		</p>

		<p>
		<label for="<?php echo $this->get_field_id( 'count' ); ?>"><?php _e( 'Items to show:', 'jetpack' ); ?></label>
		<select id="<?php echo $this->get_field_id( 'count' ); ?>" name="<?php echo $this->get_field_name( 'count' ); ?>">
			<?php $i = 1;
			while ( $i <= 10 ) { ?>
				<option <?php selected( $instance['count'], $i ) ?>><?php echo $i; ?></option>
			<?php $i++; } ?>
			<option value="0" <?php selected( $instance['count'], 0 ) ?>><?php _e( 'All' , 'jetpack' ) ?></option>
		</select>
		</p>
<?php
	}

	function update( $new_instance, $old_instance ) {
		$instance['title'] = strip_tags( $new_instance['title'] );
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
		$instance['feed-url'] = strip_tags( $new_instance['feed-url'] );
		$instance['count'] = min( absint( $new_instance['count'] ), 10 ); // 10 or less
		return $instance;
	}

	function widget( $args, $instance ) {
		jetpack_require_lib( 'icalendar-reader' );

		$ical = new iCalendarReader();
		$events = $ical->get_events( $instance['feed-url'], $instance['count'] );
		$events = $this->apply_timezone_offset( $events );
		$ical->timezone = null;

		echo $args['before_widget'];
		if ( ! empty( $instance['title'] ) ) {
			echo $args['before_title'];
			echo esc_html( $instance['title'] );
			echo $args['after_title'];
		}

		if ( ! $events ) : // nothing to display?
?>
			<p><?php echo __( 'No upcoming events', 'jetpack' ) ?></p>
<?php
		else :
?>
			<ul class="upcoming-events">
				<?php foreach ( $events as $event ) : ?>
				<li>
					<strong class="event-summary"><?php echo $ical->escape( stripslashes( $event['SUMMARY'] ) ); ?></strong>
					<span class="event-when"><?php echo $ical->formatted_date( $event ); ?></span>
					<?php if ( ! empty( $event['LOCATION'] ) ) : ?>
						<span class="event-location"><?php echo $ical->escape( stripslashes( $event['LOCATION'] ) ); ?></span>
					<?php endif; ?>
					<?php if ( ! empty( $event['DESCRIPTION'] ) ) : ?>
						<span class="event-description"><?php echo wp_trim_words( $ical->escape( stripcslashes( $event['DESCRIPTION'] ) ) ); ?></span>
					<?php endif; ?>
				</li>
				<?php endforeach; ?>
			</ul>
<?php
		endif;

		echo $args['after_widget'];

		/** This action is documented in modules/widgets/gravatar-profile.php */
		do_action( 'jetpack_stats_extra', 'widget_view', 'grofile' );
	}

	function apply_timezone_offset( $events ) {
		if ( ! $events ) {
			return $events;
		}

		// get timezone offset from the timezone name.
		$timezone_name = get_option( 'timezone_string' );
		if ( $timezone_name ) {
			$timezone = new DateTimeZone( $timezone_name );
			$offset = $timezone->getOffset( new DateTime( 'now', new DateTimeZone( 'UTC' ) ) );
		} else {
			// fallback - gmt_offset option
			$offset = get_option( 'gmt_offset' ) * 3600;
		}

		// generate a DateInterval object from the timezone offset
		$interval_string = sprintf( '%d minutes', $offset / 60 );
		$interval = date_interval_create_from_date_string( $interval_string );

		$offsetted_events = array();

		foreach ( $events as $event ) {
			// Don't handle all-day events
			if ( 8 < strlen( $event['DTSTART'] ) ) {
				$start_time = new DateTime( $event['DTSTART'] );
				$start_time->add( $interval );
				$end_time = new DateTime( $event['DTEND'] );
				$end_time->add( $interval );

				$event['DTSTART'] = $start_time->format( 'YmdHis\Z' );
				$event['DTEND'] = $end_time->format( 'YmdHis\Z' );
			}

			$offsetted_events[] = $event;
		}

		return $offsetted_events;
	}
}

function upcoming_events_register_widgets() {
	register_widget( 'Jetpack_Upcoming_Events_Widget' );
}

add_action( 'widgets_init', 'upcoming_events_register_widgets' );


1		<?php
2
3		class Jetpack_Upcoming_Events_Widget extends WP_Widget {
4		function __construct() {
5		parent::__construct(
6		'upcoming_events_widget',
7		/** This filter is documented in modules/widgets/facebook-likebox.php */
8		apply_filters( 'jetpack_widget_name', __( 'Upcoming Events', 'jetpack' ) ),
9		array(
10		'description' => __( 'Display upcoming events from an iCalendar feed.', 'jetpack' ),
11		'customize_selective_refresh' => true,
12		)
13		);
14		if ( is_active_widget( false, false, $this->id_base ) ) {
15		add_action( 'wp_head', array( $this, 'css' ) );
16		}
17		}
18
19		function css() {
20		?>
21		<style type="text/css">
22		.upcoming-events li {
23		margin-bottom: 10px;
24		}
25		.upcoming-events li span {
26		display: block;
27		}
28		</style>
29		<?php
30		}
31
32		function form( $instance ) {
33		$defaults = array(
34		'title' => __( 'Upcoming Events', 'jetpack' ),
35		'feed-url' => '',
36		'count' => 3
37		);
38		$instance = array_merge( $defaults, (array) $instance );
39		?>
40
41		<p>
42		<label for="<?php echo $this->get_field_id( 'title' ); ?>"><?php _e( 'Title:', 'jetpack' ); ?></label>
43		<input class="widefat" id="<?php echo $this->get_field_id( 'title' ); ?>" name="<?php echo $this->get_field_name( 'title' ); ?>" type="text" value="<?php echo esc_attr( $instance['title'] ); ?>" />
44		</p>
45
46		<p>
47		<label for="<?php echo $this->get_field_id( 'feed-url' ); ?>"><?php _e( 'iCalendar Feed URL:', 'jetpack' ); ?></label>
48		<input class="widefat" id="<?php echo $this->get_field_id( 'feed-url' ); ?>" name="<?php echo $this->get_field_name( 'feed-url' ); ?>" type="text" value="<?php echo esc_attr( $instance['feed-url'] ); ?>" />
49		</p>
50
51		<p>
52		<label for="<?php echo $this->get_field_id( 'count' ); ?>"><?php _e( 'Items to show:', 'jetpack' ); ?></label>
53		<select id="<?php echo $this->get_field_id( 'count' ); ?>" name="<?php echo $this->get_field_name( 'count' ); ?>">
54		<?php $i = 1;
55		while ( $i <= 10 ) { ?>
56		<option <?php selected( $instance['count'], $i ) ?>><?php echo $i; ?></option>
57		<?php $i++; } ?>
58		<option value="0" <?php selected( $instance['count'], 0 ) ?>><?php _e( 'All' , 'jetpack' ) ?></option>
59		</select>
60		</p>
61		<?php
62		}
63
64		function update( $new_instance, $old_instance ) {
65		$instance['title'] = strip_tags( $new_instance['title'] );
		0 ignored issues – show Coding Style Comprehensibility introduced 2015-11-20 23:03 UTC by Report Bug Copy Issue Report `$instance` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$instance = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
66		$instance['feed-url'] = strip_tags( $new_instance['feed-url'] );
67		$instance['count'] = min( absint( $new_instance['count'] ), 10 ); // 10 or less
68		return $instance;
69		}
70
71		function widget( $args, $instance ) {
72		jetpack_require_lib( 'icalendar-reader' );
73
74		$ical = new iCalendarReader();
75		$events = $ical->get_events( $instance['feed-url'], $instance['count'] );
76		$events = $this->apply_timezone_offset( $events );
77		$ical->timezone = null;
78
79		echo $args['before_widget'];
80		if ( ! empty( $instance['title'] ) ) {
81		echo $args['before_title'];
82		echo esc_html( $instance['title'] );
83		echo $args['after_title'];
84		}
85
86		if ( ! $events ) : // nothing to display?
87		?>
88		<p><?php echo __( 'No upcoming events', 'jetpack' ) ?></p>
89		<?php
90		else :
91		?>
92		<ul class="upcoming-events">
93		<?php foreach ( $events as $event ) : ?>
94		<li>
95		<strong class="event-summary"><?php echo $ical->escape( stripslashes( $event['SUMMARY'] ) ); ?></strong>
96		<span class="event-when"><?php echo $ical->formatted_date( $event ); ?></span>
97	View Code Duplication	<?php if ( ! empty( $event['LOCATION'] ) ) : ?>
98		<span class="event-location"><?php echo $ical->escape( stripslashes( $event['LOCATION'] ) ); ?></span>
99		<?php endif; ?>
100	View Code Duplication	<?php if ( ! empty( $event['DESCRIPTION'] ) ) : ?>
101		<span class="event-description"><?php echo wp_trim_words( $ical->escape( stripcslashes( $event['DESCRIPTION'] ) ) ); ?></span>
102		<?php endif; ?>
103		</li>
104		<?php endforeach; ?>
105		</ul>
106		<?php
107		endif;
108
109		echo $args['after_widget'];
110
111		/** This action is documented in modules/widgets/gravatar-profile.php */
112		do_action( 'jetpack_stats_extra', 'widget_view', 'grofile' );
113		}
114
115		function apply_timezone_offset( $events ) {
116		if ( ! $events ) {
117		return $events;
118		}
119
120		// get timezone offset from the timezone name.
121		$timezone_name = get_option( 'timezone_string' );
122		if ( $timezone_name ) {
123		$timezone = new DateTimeZone( $timezone_name );
124		$offset = $timezone->getOffset( new DateTime( 'now', new DateTimeZone( 'UTC' ) ) );
125		} else {
126		// fallback - gmt_offset option
127		$offset = get_option( 'gmt_offset' ) * 3600;
128		}
129
130		// generate a DateInterval object from the timezone offset
131		$interval_string = sprintf( '%d minutes', $offset / 60 );
132		$interval = date_interval_create_from_date_string( $interval_string );
133
134		$offsetted_events = array();
135
136		foreach ( $events as $event ) {
137		// Don't handle all-day events
138		if ( 8 < strlen( $event['DTSTART'] ) ) {
139		$start_time = new DateTime( $event['DTSTART'] );
140		$start_time->add( $interval );
141		$end_time = new DateTime( $event['DTEND'] );
142		$end_time->add( $interval );
143
144		$event['DTSTART'] = $start_time->format( 'YmdHis\Z' );
145		$event['DTEND'] = $end_time->format( 'YmdHis\Z' );
146		}
147
148		$offsetted_events[] = $event;
149		}
150
151		return $offsetted_events;
152		}
153		}
154
155		function upcoming_events_register_widgets() {
156		register_widget( 'Jetpack_Upcoming_Events_Widget' );
157		}
158
159		add_action( 'widgets_init', 'upcoming_events_register_widgets' );
160

Automattic / jetpack

Push — branch-4.6-built ( 825187 )

Jetpack_Upcoming_Events_Widget::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like