MapUtil::set_center() - Code Metrics - gordonbanderson/Mappable - Measure and Improve Code Quality continuously with Scrutinizer

MapUtil::set_center() A
last analyzed 2018-10-01 19:38 UTC

↳ Parent: MapUtil

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	1

<?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 bool Automatic center/zoom for the map
     */
    public static $automatic_center = true;

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

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

    /**
     * @var string 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;
        Config::inst()->update('Mappable', 'language', 'en');
    }

    /**
     * Set the API key for Google Maps.
     *
     * @param string $key
     */
    public static function set_api_key($key)

    {
        self::$api_key = $key;
    }

    /**
     * @param bool $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')
     */
    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)
     */
    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);
        $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);
        $language = Config::inst()->get('Mappable', 'language');
        $gmap->setLang($language);

        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		* @var string The Google Maps API key
7		*/
8		protected static $api_key;
9
10		/**
11		* @var int Number of active {@see GoogleMapsAPI} instances (for the HTML ID)
12		*/
13		protected static $instances = 0;
14
15		/**
16		* @var int The default width of a Google Map
17		*/
18		public static $map_width = '100%';
19
20		/**
21		* @var int The default height of a Google Map
22		*/
23		public static $map_height = '400px';
24
25		/**
26		* @var int Prefix for the div ID of the map
27		*/
28		public static $div_id = 'google_map';
29
30		/**
31		* @var bool Automatic center/zoom for the map
32		*/
33		public static $automatic_center = true;
34
35		/**
36		* @var bool Show the marker fields on the map
37		*/
38		public static $hide_marker = false;
39
40		/**
41		* @var bool Show the marker fields on the map
42		*/
43		public static $map_type = 'google.maps.MapTypeId.ROADMAP';
44
45		/**
46		* @var string Center of map (adress)
47		*/
48		public static $center = 'Paris, France';
49
50		/* Signals whether at least one map has already been rendered */
51		private static $map_already_rendered = false;
52
53		/* Whether or not to allow full screen */
54		private static $allow_full_screen = null;
55
56	49	public static function reset()
57		{
58	49	self::$api_key = null;
59	49	self::$instances = 0;
60	49	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...
61	49	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...
62	49	self::$div_id = 'google_map';
		0 ignored issues – show Documentation Bug introduced 2016-01-05 06:25 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...
63	49	self::$automatic_center = true;
64	49	self::$hide_marker = false;
65	49	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...
66	49	self::$center = 'Paris, France';
67	49	self::$map_already_rendered = false;
68	49	self::$allow_full_screen = null;
69	49	Config::inst()->update('Mappable', 'language', 'en');
70	49	}
71
72		/**
73		* Set the API key for Google Maps.
74		*
75		* @param string $key
76		*/
77	2	public static function set_api_key($key)
		0 ignored issues – show Coding Style introduced 2016-01-05 06:05 UTC by Report Bug Copy Issue Report Method name "MapUtil::set_api_key" is not in camel caps format Loading history...
78		{
79	2	self::$api_key = $key;
80	2	}
81
82		/**
83		* @param bool $new_map_already_rendered
84		*/
85	43	public static function set_map_already_rendered($new_map_already_rendered)
		0 ignored issues – show Coding Style introduced 2016-01-05 06:05 UTC by Report Bug Copy Issue Report Method name "MapUtil::set_map_already_rendered" is not in camel caps format Loading history...
86		{
87	43	self::$map_already_rendered = $new_map_already_rendered;
88	43	}
89
90	43	public static function get_map_already_rendered()
		0 ignored issues – show Coding Style introduced 2016-01-05 06:05 UTC by Report Bug Copy Issue Report Method name "MapUtil::get_map_already_rendered" is not in camel caps format Loading history...
91		{
92	43	return self::$map_already_rendered;
93		}
94
95		/**
96		* Set the default size of the map.
97		*
98		* @param int $width
99		* @param int $height
100		*/
101	1	public static function set_map_size($width, $height)
		0 ignored issues – show Coding Style introduced 2016-01-05 06:05 UTC by Report Bug Copy Issue Report Method name "MapUtil::set_map_size" is not in camel caps format Loading history...
102		{
103	1	self:: $map_width = $width;
104	1	self::$map_height = $height;
105	1	}
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	1	public static function set_map_type($mapType)
		0 ignored issues – show Coding Style introduced 2016-01-05 06:05 UTC by Report Bug Copy Issue Report Method name "MapUtil::set_map_type" is not in camel caps format Loading history...
115		{
116	1	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...
117	1	}
118
119		/**
120		* Set the center of the gmap (an address, using text geocoder query).
121		*
122		* @param string $center GoogleMap center (an address)
123		*/
124	1	public static function set_center($center)
		0 ignored issues – show Coding Style introduced 2016-01-05 06:05 UTC by Report Bug Copy Issue Report Method name "MapUtil::set_center" is not in camel caps format Loading history...
125		{
126	1	self::$center = $center;
127	1	}
128
129		/**
130		* Get a new GoogleMapAPI object and load it with the default settings.
131		*
132		* @return MapAPI
133		*/
134	41	public static function instance()
135		{
136	41	++self::$instances;
137
138	41	if (self::$allow_full_screen == null) {
139	39	self::$allow_full_screen = Config::inst()->get('Mappable', 'allow_full_screen');
140	39	}
141
142	41	$url = Director::absoluteBaseURL();
143
144		// remove http and https
145	41	$url = str_replace('http://', '', $url);
146	41	$url = str_replace('https://', '', $url);
147	41	$parts = explode('/', $url);
148	41	$host = $parts[0];
149
150	41	$key = self::$api_key;
151
152		// if an array, get the key by an array keyed by host
153	41	if (is_array($key)) {
154	1	$key = $key[$host];
155	1	}
156
157	41	$gmap = new MapAPI($key);
158	41	$gmap->setDivId(self::$div_id.'_'.self::$instances);
159	41	$gmap->setEnableAutomaticCenterZoom(self::$automatic_center);
160	41	$gmap->setSize(self::$map_width, self::$map_height);
161	41	$gmap->setDefaultHideMarker(self::$hide_marker);
162	41	$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...
163	41	$gmap->setCenter(self::$center);
164	41	$gmap->setAllowFullScreen(self::$allow_full_screen);
165	41	$language = Config::inst()->get('Mappable', 'language');
166	41	$gmap->setLang($language);
167
168	41	return $gmap;
169		}
170
171		/**
172		* Sanitize a string of HTML content for safe inclusion in the JavaScript
173		* for a Google Map.
174		*
175		* @return string
176		*/
177	14	public static function sanitize($content)
178		{
179	14	return addslashes(str_replace(array("\n", "\r", "\t"), '', $content));
180		}
181
182		/**
183		* Creates a new {@link GoogleMapsAPI} object loaded with the default settings
184		* and places all of the items in a {@link SS_List}
185		* e.g. {@link DataList} or {@link ArrayList} on the map.
186		*
187		* @param SS_List list of objects to display on a map
188		* @param array $infowindowtemplateparams Optional array of extra parameters to pass to the map info window
189		*
190		* @return MapAPI
191		*/
192	41	public static function get_map(SS_List $list, $infowindowtemplateparams)
		0 ignored issues – show Coding Style introduced 2016-01-05 06:05 UTC by Report Bug Copy Issue Report Method name "MapUtil::get_map" is not in camel caps format Loading history...
193		{
194	41	$gmap = self::instance();
195	41	if ($list) {
196	41	foreach ($list as $mappable) {
197	36	if (self::ChooseToAddDataobject($mappable)) {
198	8	$gmap->addMarkerAsObject($mappable, $infowindowtemplateparams);
199	8	}
200	41	}
201	41	}
202
203	41	return $gmap;
204		}
205
206		/**
207		* Determines if the current DataObject should be included to the map
208		* Checks if it has Mappable interface implemented
209		* If it has MapExtension included, the value of MapPinEdited is also checked.
210		*
211		* @param DataObject $do
212		*
213		* @return bool
214		*/
215	36	private static function ChooseToAddDataobject(DataObject $do)
		0 ignored issues – show Coding Style introduced 2016-01-05 06:05 UTC by Report Bug Copy Issue Report Method name "MapUtil::ChooseToAddDataobject" is not in camel caps format Loading history...
216		{
217	36	$isMappable = $do->is_a('Mappable');
218
219	36	foreach ($do->getExtensionInstances() as $extension) {
220	36	$isMappable = $isMappable \|\| $extension instanceof Mappable;
221	36	}
222
223	36	$filterMapPinEdited = $do->hasExtension('MapExtension')
224	36	? $do->MapPinEdited
225	36	: true;
226
227	36	return $isMappable && $filterMapPinEdited;
228		}
229		}
230

gordonbanderson / Mappable

MapUtil::set_center() A last analyzed 2018-10-01 19:38 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

MapUtil::set_center() A
last analyzed 2018-10-01 19:38 UTC