MapUtil - Code Metrics - Inspection of "ENHANCEMENT: Geocoding and add mappable marker tes..." - gordonbanderson/Mappable - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — AUTOMATED_TESTING ( 6591ac...6229f9 )

by Gordon

created 2015-12-25 04:45 UTC

MapUtil A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	222
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Metric	Value
wmc	20
lcom	1
cbo	4
dl	0
loc	222
rs	10

11 Methods

Rating	Name	Size	Complexity
A	reset()	13	1
A	set_api_key()	3	1
A	set_map_already_rendered()	3	1
A	get_map_already_rendered()	3	1
A	set_map_size()	4	1
A	set_map_type()	3	1
A	set_center()	4	1
B	instance()	33	3
A	sanitize()	3	1
A	get_map()	10	4
B	ChooseToAddDataobject()	13	5

<?php

class MapUtil
{

	/**
	 * @var string The Google Maps API key
	 */
	protected static $api_key;

	/**
	 * @var int Number of active {@see GoogleMapsAPI} instances (for the HTML ID)
	 */
	protected static $instances = 0;

	/**
	 * @var int The default width of a Google Map
	 */
	public static $map_width = '100%';

	/**
	 * @var int The default height of a Google Map
	 */
	public static $map_height = '400px';

	/**
	 * @var int Prefix for the div ID of the map
	 */
	public static $div_id = "google_map";

	/**
	 * @var boolean Automatic center/zoom for the map
	 */
	public static $automatic_center = true;

	/**
	 * @var boolean Show the marker fields on the map
	 */
	public static $hide_marker = false;




	/**
	 * @var boolean Show the marker fields on the map
	 */
	public static $map_type = 'google.maps.MapTypeId.ROADMAP';

	/**
	 * @var string $center Center of map (adress)
	 */
	public static $center = 'Paris, France';

	/* Signals whether at least one map has already been rendered */
	private static $map_already_rendered = false;

	/* Whether or not to allow full screen */
	private static $allow_full_screen = null;


	public static function reset() {
		self::$api_key = null;
		self::$instances = 0;
		self::$map_width = '100%';
$answer = 42;

$correct = false;

$correct = (bool) $answer;
		self::$map_height = '400px';
$answer = 42;

$correct = false;

$correct = (bool) $answer;
		self::$div_id = "google_map";
$answer = 42;

$correct = false;

$correct = (bool) $answer;
		self::$automatic_center = true;
		self::$hide_marker = false;
		self::$map_type = 'google.maps.MapTypeId.ROADMAP';
$answer = 42;

$correct = false;

$correct = (bool) $answer;
		self::$center = 'Paris, France';
		self::$map_already_rendered = false;
		self::$allow_full_screen = null;
	}

	/**
	 * Set the API key for Google Maps
	 *
	 * @param string $key
	 */
	public static function set_api_key($key) {
		self::$api_key = $key;
	}


	/**
	 * @param boolean $new_map_already_rendered
	 */
	public static function set_map_already_rendered($new_map_already_rendered) {
		self::$map_already_rendered = $new_map_already_rendered;
	}

	public static function get_map_already_rendered() {
		return self::$map_already_rendered;
	}

	/**
	 * Set the default size of the map
	 *
	 * @param int $width
	 * @param int $height
	 */
	public static function set_map_size($width, $height) {
		self:: $map_width = $width;
		self::$map_height = $height;
	}

	/**
	 * FIXME - NOT USED?
	 * Set the type of the gmap
	 *
	 * @param string $mapType (can be 'google.maps.MapTypeId.ROADMAP', 'G_SATELLITE_MAP',
	 * 'G_HYBRID_MAP', 'G_PHYSICAL_MAP')
	 *
	 * @return void
	 */
	public static function set_map_type($mapType) {
		self::$map_type = $mapType;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
	}

	/**
	 * Set the center of the gmap (an address, using text geocoder query)
	 *
	 * @param string $center GoogleMap  center (an address)
	 *
	 * @return void
	 */
	public static function set_center($center)
	{
		self::$center = $center;
	}

	/**
	 * Get a new GoogleMapAPI object and load it with the default settings
	 *
	 * @return MapAPI
	 */
	public static function instance()
	{
		self::$instances++;

		if (self::$allow_full_screen == null) {
			self::$allow_full_screen = Config::inst()->get('Mappable', 'allow_full_screen');
		}

		$url = Director::absoluteBaseURL();

		// remove http and https
		$url = str_replace('http://', '', $url);
		$url = str_replace('https://', '', $url);
		$parts = explode('/', $url);
		$host = $parts[0];

		$key = self::$api_key;

		// if an array, get the key by an array keyed by host
		if (is_array($key)) {
			$key = $key[$host];
		}

		$gmap = new MapAPI($key);
		$gmap->setDivId(self::$div_id."_".self::$instances);
		$gmap->setEnableAutomaticCenterZoom(self::$automatic_center);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		$gmap->setSize(self::$map_width, self::$map_height);
		$gmap->setDefaultHideMarker(self::$hide_marker);
		$gmap->setMapType(self::$map_type);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		$gmap->setCenter(self::$center);
		$gmap->setAllowFullScreen(self::$allow_full_screen);
		return $gmap;
	}


	/**
	 * Sanitize a string of HTML content for safe inclusion in the JavaScript
	 * for a Google Map
	 *
	 * @return string
	 */
	public static function sanitize($content) {
		return addslashes(str_replace(array("\n", "\r", "\t"), '', $content));
	}


	/**
	 * Creates a new {@link GoogleMapsAPI} object loaded with the default settings
	 * and places all of the items in a {@link SS_List}
	 * e.g. {@link DataList} or {@link ArrayList} on the map
	 *
	 * @param SS_List list of objects to display on a map
	 * @param  array $infowindowtemplateparams Optional array of extra parameters to pass to the map info window
	 * @return MapAPI
	 */
	public static function get_map(SS_List $list, $infowindowtemplateparams) {
		$gmap = self::instance();
		if ($list) {
			foreach ($list as $mappable) {
				if (self::ChooseToAddDataobject($mappable))
					$gmap->addMarkerAsObject($mappable, $infowindowtemplateparams);
			}
		}
		return $gmap;
	}

	/**
	 * Determines if the current DataObject should be included to the map
	 * Checks if it has Mappable interface implemented
	 * If it has MapExtension included, the value of MapPinEdited is also checked
	 *
	 * @param DataObject $do
	 * @return bool
	 */
	private static function ChooseToAddDataobject(DataObject $do) {
		$isMappable = $do->is_a('Mappable');

		foreach ($do->getExtensionInstances() as $extension) {
			$isMappable = $isMappable || $extension instanceof Mappable;
		}

		$filterMapPinEdited = $do->hasExtension('MapExtension')
			? $do->MapPinEdited
			: true;

		return $isMappable && $filterMapPinEdited;
	}
}


1			<?php
2
3			class MapUtil
4			{
5
6			/**
7			* @var string The Google Maps API key
8			*/
9			protected static $api_key;
10
11			/**
12			* @var int Number of active {@see GoogleMapsAPI} instances (for the HTML ID)
13			*/
14			protected static $instances = 0;
15
16			/**
17			* @var int The default width of a Google Map
18			*/
19			public static $map_width = '100%';
20
21			/**
22			* @var int The default height of a Google Map
23			*/
24			public static $map_height = '400px';
25
26			/**
27			* @var int Prefix for the div ID of the map
28			*/
29			public static $div_id = "google_map";
30
31			/**
32			* @var boolean Automatic center/zoom for the map
33			*/
34			public static $automatic_center = true;
35
36			/**
37			* @var boolean Show the marker fields on the map
38			*/
39			public static $hide_marker = false;
40
41
42
43
44			/**
45			* @var boolean Show the marker fields on the map
46			*/
47			public static $map_type = 'google.maps.MapTypeId.ROADMAP';
48
49			/**
50			* @var string $center Center of map (adress)
51			*/
52			public static $center = 'Paris, France';
53
54			/* Signals whether at least one map has already been rendered */
55			private static $map_already_rendered = false;
56
57			/* Whether or not to allow full screen */
58			private static $allow_full_screen = null;
59
60
61			public static function reset() {
62			self::$api_key = null;
63			self::$instances = 0;
64			self::$map_width = '100%';
			0 ignored issues – show Documentation Bug introduced 2015-12-22 20:35 UTC by Report Bug Copy Issue Report The property `$map_width` was declared of type `integer`, but `'100%'` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
65			self::$map_height = '400px';
			0 ignored issues – show Documentation Bug introduced 2015-12-22 20:35 UTC by Report Bug Copy Issue Report The property `$map_height` was declared of type `integer`, but `'400px'` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
66			self::$div_id = "google_map";
			0 ignored issues – show Documentation Bug introduced 2015-12-22 20:35 UTC by Report Bug Copy Issue Report The property `$div_id` was declared of type `integer`, but `'google_map'` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
67			self::$automatic_center = true;
68			self::$hide_marker = false;
69			self::$map_type = 'google.maps.MapTypeId.ROADMAP';
			0 ignored issues – show Documentation Bug introduced 2015-12-22 20:35 UTC by Report Bug Copy Issue Report The property `$map_type` was declared of type `boolean`, but `'google.maps.MapTypeId.ROADMAP'` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
70			self::$center = 'Paris, France';
71			self::$map_already_rendered = false;
72			self::$allow_full_screen = null;
73			}
74
75			/**
76			* Set the API key for Google Maps
77			*
78			* @param string $key
79			*/
80			public static function set_api_key($key) {
81			self::$api_key = $key;
82			}
83
84
85			/**
86			* @param boolean $new_map_already_rendered
87			*/
88			public static function set_map_already_rendered($new_map_already_rendered) {
89			self::$map_already_rendered = $new_map_already_rendered;
90			}
91
92			public static function get_map_already_rendered() {
93			return self::$map_already_rendered;
94			}
95
96			/**
97			* Set the default size of the map
98			*
99			* @param int $width
100			* @param int $height
101			*/
102			public static function set_map_size($width, $height) {
103			self:: $map_width = $width;
104			self::$map_height = $height;
105			}
106
107			/**
108			* FIXME - NOT USED?
109			* Set the type of the gmap
110			*
111			* @param string $mapType (can be 'google.maps.MapTypeId.ROADMAP', 'G_SATELLITE_MAP',
112			* 'G_HYBRID_MAP', 'G_PHYSICAL_MAP')
113			*
114			* @return void
115			*/
116			public static function set_map_type($mapType) {
117			self::$map_type = $mapType;
			0 ignored issues – show Documentation Bug introduced 2015-12-18 15:00 UTC by Report Bug Copy Issue Report The property `$map_type` was declared of type `boolean`, but `$mapType` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
118			}
119
120			/**
121			* Set the center of the gmap (an address, using text geocoder query)
122			*
123			* @param string $center GoogleMap center (an address)
124			*
125			* @return void
126			*/
127			public static function set_center($center)
128			{
129			self::$center = $center;
130			}
131
132			/**
133			* Get a new GoogleMapAPI object and load it with the default settings
134			*
135			* @return MapAPI
136			*/
137			public static function instance()
138			{
139			self::$instances++;
140
141			if (self::$allow_full_screen == null) {
142			self::$allow_full_screen = Config::inst()->get('Mappable', 'allow_full_screen');
143			}
144
145			$url = Director::absoluteBaseURL();
146
147			// remove http and https
148			$url = str_replace('http://', '', $url);
149			$url = str_replace('https://', '', $url);
150			$parts = explode('/', $url);
151			$host = $parts[0];
152
153			$key = self::$api_key;
154
155			// if an array, get the key by an array keyed by host
156			if (is_array($key)) {
157			$key = $key[$host];
158			}
159
160			$gmap = new MapAPI($key);
161			$gmap->setDivId(self::$div_id."_".self::$instances);
162			$gmap->setEnableAutomaticCenterZoom(self::$automatic_center);
			0 ignored issues – show Documentation introduced 2015-12-21 19:55 UTC by Report Bug Copy Issue Report `self::$automatic_center` is of type `boolean`, but the function expects a `integer`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
163			$gmap->setSize(self::$map_width, self::$map_height);
164			$gmap->setDefaultHideMarker(self::$hide_marker);
165			$gmap->setMapType(self::$map_type);
			0 ignored issues – show Documentation introduced 2015-12-18 15:00 UTC by Report Bug Copy Issue Report `self::$map_type` is of type `boolean`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
166			$gmap->setCenter(self::$center);
167			$gmap->setAllowFullScreen(self::$allow_full_screen);
168			return $gmap;
169			}
170
171
172			/**
173			* Sanitize a string of HTML content for safe inclusion in the JavaScript
174			* for a Google Map
175			*
176			* @return string
177			*/
178			public static function sanitize($content) {
179			return addslashes(str_replace(array("\n", "\r", "\t"), '', $content));
180			}
181
182
183			/**
184			* Creates a new {@link GoogleMapsAPI} object loaded with the default settings
185			* and places all of the items in a {@link SS_List}
186			* e.g. {@link DataList} or {@link ArrayList} on the map
187			*
188			* @param SS_List list of objects to display on a map
189			* @param array $infowindowtemplateparams Optional array of extra parameters to pass to the map info window
190			* @return MapAPI
191			*/
192			public static function get_map(SS_List $list, $infowindowtemplateparams) {
193			$gmap = self::instance();
194			if ($list) {
195			foreach ($list as $mappable) {
196			if (self::ChooseToAddDataobject($mappable))
197			$gmap->addMarkerAsObject($mappable, $infowindowtemplateparams);
198			}
199			}
200			return $gmap;
201			}
202
203			/**
204			* Determines if the current DataObject should be included to the map
205			* Checks if it has Mappable interface implemented
206			* If it has MapExtension included, the value of MapPinEdited is also checked
207			*
208			* @param DataObject $do
209			* @return bool
210			*/
211			private static function ChooseToAddDataobject(DataObject $do) {
212			$isMappable = $do->is_a('Mappable');
213
214			foreach ($do->getExtensionInstances() as $extension) {
215			$isMappable = $isMappable \|\| $extension instanceof Mappable;
216			}
217
218			$filterMapPinEdited = $do->hasExtension('MapExtension')
219			? $do->MapPinEdited
220			: true;
221
222			return $isMappable && $filterMapPinEdited;
223			}
224			}
225

gordonbanderson / Mappable

Push — AUTOMATED_TESTING ( 6591ac...6229f9 )

MapUtil A

Complexity

Size/Duplication

Coupling/Cohesion

11 Methods

Duplication Side-by-Side

Filter issues like