MapUtil

Complexity

Total Complexity

20

Size/Duplication

Total Lines	227
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	reset()	0	15	1
A	set_api_key()	0	4	1
A	set_map_already_rendered()	0	4	1
A	get_map_already_rendered()	0	4	1
A	set_map_size()	0	5	1
A	set_map_type()	0	4	1
A	set_center()	0	4	1
A	instance()	0	36	3
A	sanitize()	0	4	1
A	get_map()	0	13	4
A	ChooseToAddDataobject()	0	14	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 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%';

The property $map_width was declared of type integer, but '100%' is of type string. Maybe add a type cast?

        self::$map_height = '400px';

The property $map_height was declared of type integer, but '400px' is of type string. Maybe add a type cast?

        self::$div_id = 'google_map';

The property $div_id was declared of type integer, but 'google_map' is of type string. Maybe add a type cast?

        self::$automatic_center = true;
        self::$hide_marker = false;
        self::$map_type = 'google.maps.MapTypeId.ROADMAP';

The property $map_type was declared of type boolean, but 'google.maps.MapTypeId.ROADMAP' is of type string. Maybe add a type cast?

        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)

Method name "MapUtil::set_api_key" is not in camel caps format

    {
        self::$api_key = $key;
    }

    /**
     * @param bool $new_map_already_rendered
     */
    public static function set_map_already_rendered($new_map_already_rendered)

Method name "MapUtil::set_map_already_rendered" is not in camel caps format

    {
        self::$map_already_rendered = $new_map_already_rendered;
    }

    public static function get_map_already_rendered()

Method name "MapUtil::get_map_already_rendered" is not in camel caps format

    {
        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)

Method name "MapUtil::set_map_size" is not in camel caps format

    {
        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)

Method name "MapUtil::set_map_type" is not in camel caps format

    {
        self::$map_type = $mapType;

The property $map_type was declared of type boolean, but $mapType is of type string. Maybe add a type cast?

    }

    /**
     * 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)

Method name "MapUtil::set_center" is not in camel caps format

    {
        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);

self::$map_type is of type boolean, but the function expects a string.

        $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)

Method name "MapUtil::get_map" is not in camel caps format

    {
        $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)

Method name "MapUtil::ChooseToAddDataobject" is not in camel caps format

    {
        $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;
    }
}