Issues in IcalTimezoneFormatter.php - All Issues - Inspection of "Provide "gantt" format (#467)" - SemanticMediaWiki/SemanticResultFormats - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6dc7d8...407c40 )

by Karsten

created 2019-05-06 14:27 UTC

src/iCalendar/IcalTimezoneFormatter.php (2 issues)

Labels

Severity

mwjames 2

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace SRF\iCalendar;

use DateTimeZone;
use Exception;

/**
 * Create the iCalendar's vTimezone component
 *
 * @license GNU GPL v2+
 * @since 3.0
 *
 * @author HgO
 */
class IcalTimezoneFormatter {

	/**
	 * @var array
	 */
	private $localTimezones = [];

	/**
	 * @var array
	 */
	private $transitions = [];

	/**
	 * @var array
	 */
	private $offsets = [];

	/**
	 * @since 3.0
	 */
	public function __construct() {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
		$this->localTimezones = [ $GLOBALS['wgLocaltimezone'] ];
	}

	/**
	 * Set a list of local timezones.
	 *
	 * @since 3.0
	 *
	 * @param array|string $localTimezones
	 */
	public function setLocalTimezones( $localTimezones ) {

		if ( is_array( $localTimezones ) ) {
			$localTimezones = $localTimezones;

		} elseif ( strpos( $localTimezones, ',' ) !== false ) {
			$localTimezones = explode( ',', $localTimezones );
		} elseif ( $localTimezones !== '' ) {
			$localTimezones = [ $localTimezones ];
		} else {
			$localTimezones = [];
		}

		$this->localTimezones = $localTimezones;
	}

	/**
	 * Calculate transitions for each timezone.
	 *
	 * @since 3.0
	 *
	 * @param integer $from Timestamp from which transitions are generated.
	 * @param integer $to Timestamp until which transitions are generated.
	 *
	 * @return boolean
	 */
	public function calcTransitions( $from = null, $to = null ) {

		if ( $this->localTimezones === [] ) {
			return false;
		}

		if ( $from === null || $to === null ) {
			return false;
		}

		foreach ( $this->localTimezones as $timezone ) {
			try {
				$dateTimezone = new DateTimeZone( $timezone );
			}
			catch ( Exception $e ) {
				continue;
			}

			$transitions = $dateTimezone->getTransitions( $from, $to );

			if ( $transitions === false ) {
				continue;
			}

			$min = 0;
			$max = 1;

			foreach ( $transitions as $i => $transition ) {
				if ( $transition['ts'] < $from ) {
					$min = $i;
					continue;
				}

				if ( $transition['ts'] > $to ) {
					$max = $i;
					break;
				}
			}

			$this->offsets[$timezone] = $transitions[max( $min - 1, 0 )]['offset'];
			$this->transitions[$timezone] = array_slice( $transitions, $min, $max - $min );
		}

		return true;
	}

	/**
	 * Generate the transitions for a given range, for each timezones, in the
	 * iCalendar format.
	 *
	 * @since 3.0
	 *
	 * @return string
	 */
	public function getTransitions() {

		$result = '';

		if ( $this->transitions === null || $this->transitions === [] ) {
			return $result;
		}

		foreach ( $this->transitions as $timezone => $transitions ) {
			// cf. http://www.kanzaki.com/docs/ical/vtimezone.html
			$result .= "BEGIN:VTIMEZONE\r\n";
			$result .= "TZID:$timezone\r\n";

			$tzfrom = $this->offsets[$timezone] / 3600;
			foreach ( $transitions as $transition ) {
				$dst = ( $transition['isdst'] ) ? "DAYLIGHT" : "STANDARD";
				$result .= "BEGIN:$dst\r\n";

				$start_date = date( 'Ymd\THis', $transition['ts'] );
				$result .= "DTSTART:$start_date\r\n";

				$offset = $transition['offset'] / 3600;

				$offset_from = $this->formatTimezoneOffset( $tzfrom );
				$result .= "TZOFFSETFROM:$offset_from\r\n";

				$offset_to = $this->formatTimezoneOffset( $offset );
				$result .= "TZOFFSETTO:$offset_to\r\n";

				if ( !empty( $transition['abbr'] ) ) {
					$result .= "TZNAME:{$transition['abbr']}\r\n";
				}

				$result .= "END:$dst\r\n";

				$tzfrom = $offset;
			}

			$result .= "END:VTIMEZONE\r\n";
		}

		// Clear the calculation
		$this->transitions = [];

		return $result;
	}

	/**
	 * Format an integer offset to '+hhii', where hh are the hours, and ii the
	 * minutes
	 *
	 * @param int $offset
	 */
	private function formatTimezoneOffset( $offset ) {
		return sprintf( '%s%02d%02d', $offset >= 0 ? '+' : '-', abs( floor( $offset ) ), ( $offset - floor( $offset ) ) * 60 );
	}

}


1		<?php
2
3		namespace SRF\iCalendar;
4
5		use DateTimeZone;
6		use Exception;
7
8		/**
9		* Create the iCalendar's vTimezone component
10		*
11		* @license GNU GPL v2+
12		* @since 3.0
13		*
14		* @author HgO
15		*/
16		class IcalTimezoneFormatter {
17
18		/**
19		* @var array
20		*/
21		private $localTimezones = [];
22
23		/**
24		* @var array
25		*/
26		private $transitions = [];
27
28		/**
29		* @var array
30		*/
31		private $offsets = [];
32
33		/**
34		* @since 3.0
35		*/
36	8	public function __construct() {
		0 ignored issues – show Coding Style introduced 2017-11-04 09:02 UTC by Report Bug Copy Issue Report Show Similar Issues like this `__construct` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
37	8	$this->localTimezones = [ $GLOBALS['wgLocaltimezone'] ];
38	8	}
39
40		/**
41		* Set a list of local timezones.
42		*
43		* @since 3.0
44		*
45		* @param array\|string $localTimezones
46		*/
47	7	public function setLocalTimezones( $localTimezones ) {
48
49	7	if ( is_array( $localTimezones ) ) {
50		$localTimezones = $localTimezones;
		0 ignored issues – show Bug introduced 2017-11-04 09:02 UTC by Report Bug Copy Issue Report Show Similar Issues like this Why assign `$localTimezones` to itself? This checks looks for cases where a variable has been assigned to itself. This assignement can be removed without consequences. Loading history...
51	7	} elseif ( strpos( $localTimezones, ',' ) !== false ) {
52	1	$localTimezones = explode( ',', $localTimezones );
53	7	} elseif ( $localTimezones !== '' ) {
54	5	$localTimezones = [ $localTimezones ];
55		} else {
56	2	$localTimezones = [];
57		}
58
59	7	$this->localTimezones = $localTimezones;
60	7	}
61
62		/**
63		* Calculate transitions for each timezone.
64		*
65		* @since 3.0
66		*
67		* @param integer $from Timestamp from which transitions are generated.
68		* @param integer $to Timestamp until which transitions are generated.
69		*
70		* @return boolean
71		*/
72	7	public function calcTransitions( $from = null, $to = null ) {
73
74	7	if ( $this->localTimezones === [] ) {
75	2	return false;
76		}
77
78	5	if ( $from === null \|\| $to === null ) {
79		return false;
80		}
81
82	5	foreach ( $this->localTimezones as $timezone ) {
83		try {
84	5	$dateTimezone = new DateTimeZone( $timezone );
85		}
86	1	catch ( Exception $e ) {
87	1	continue;
88		}
89
90	5	$transitions = $dateTimezone->getTransitions( $from, $to );
91
92	5	if ( $transitions === false ) {
93		continue;
94		}
95
96	5	$min = 0;
97	5	$max = 1;
98
99	5	foreach ( $transitions as $i => $transition ) {
100	5	if ( $transition['ts'] < $from ) {
101		$min = $i;
102		continue;
103		}
104
105	5	if ( $transition['ts'] > $to ) {
106		$max = $i;
107	5	break;
108		}
109		}
110
111	5	$this->offsets[$timezone] = $transitions[max( $min - 1, 0 )]['offset'];
112	5	$this->transitions[$timezone] = array_slice( $transitions, $min, $max - $min );
113		}
114
115	5	return true;
116		}
117
118		/**
119		* Generate the transitions for a given range, for each timezones, in the
120		* iCalendar format.
121		*
122		* @since 3.0
123		*
124		* @return string
125		*/
126	7	public function getTransitions() {
127
128	7	$result = '';
129
130	7	if ( $this->transitions === null \|\| $this->transitions === [] ) {
131	2	return $result;
132		}
133
134	5	foreach ( $this->transitions as $timezone => $transitions ) {
135		// cf. http://www.kanzaki.com/docs/ical/vtimezone.html
136	5	$result .= "BEGIN:VTIMEZONE\r\n";
137	5	$result .= "TZID:$timezone\r\n";
138
139	5	$tzfrom = $this->offsets[$timezone] / 3600;
140	5	foreach ( $transitions as $transition ) {
141	5	$dst = ( $transition['isdst'] ) ? "DAYLIGHT" : "STANDARD";
142	5	$result .= "BEGIN:$dst\r\n";
143
144	5	$start_date = date( 'Ymd\THis', $transition['ts'] );
145	5	$result .= "DTSTART:$start_date\r\n";
146
147	5	$offset = $transition['offset'] / 3600;
148
149	5	$offset_from = $this->formatTimezoneOffset( $tzfrom );
150	5	$result .= "TZOFFSETFROM:$offset_from\r\n";
151
152	5	$offset_to = $this->formatTimezoneOffset( $offset );
153	5	$result .= "TZOFFSETTO:$offset_to\r\n";
154
155	5	if ( !empty( $transition['abbr'] ) ) {
156	5	$result .= "TZNAME:{$transition['abbr']}\r\n";
157		}
158
159	5	$result .= "END:$dst\r\n";
160
161	5	$tzfrom = $offset;
162		}
163
164	5	$result .= "END:VTIMEZONE\r\n";
165		}
166
167		// Clear the calculation
168	5	$this->transitions = [];
169
170	5	return $result;
171		}
172
173		/**
174		* Format an integer offset to '+hhii', where hh are the hours, and ii the
175		* minutes
176		*
177		* @param int $offset
178		*/
179	5	private function formatTimezoneOffset( $offset ) {
180	5	return sprintf( '%s%02d%02d', $offset >= 0 ? '+' : '-', abs( floor( $offset ) ), ( $offset - floor( $offset ) ) * 60 );
181		}
182
183		}
184

SemanticMediaWiki / SemanticResultFormats

Push — master ( 6dc7d8...407c40 )

src/iCalendar/IcalTimezoneFormatter.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like