gordonbanderson / Mappable

code/MapExtension.php

Doc Comments +1 added lines, -1 removed lines

@@ -184,7 +184,7 @@
 
 	/**
 	 * Access the map editing field for the purpose of adding guide points
-	 * @return [LatLongField] instance of location editing field
+	 * @return FormField instance of location editing field
 	 */
 	public function getMapField() {
 		if (!isset($this->mapField)) {

Spacing +2 added lines, -2 removed lines

@@ -18,7 +18,7 @@ 
 		'MapPinIcon' => 'Image'
 	);
 
-	static $defaults = array (
+	static $defaults = array(
 		'Lat' =>0,
 		'Lon' => 0,
 		'Zoom' => 4,
@@ -154,7 +154,7 @@ 
 
 		// add any KML map layers
 		if (Object::has_extension($this->owner->ClassName, 'MapLayerExtension')) {
-		  foreach($this->owner->MapLayers() as $layer) {
+		  foreach ($this->owner->MapLayers() as $layer) {
 			$map->addKML($layer->KmlFile()->getAbsoluteURL());
 			// we have a layer, so turn on autozoom
 			$autozoom = true;

Indentation +172 added lines, -173 removed lines

@@ -2,173 +2,173 @@ 
 
 class MapExtension extends DataExtension implements Mappable {
 
-	/*
+    /*
 	 * Template suffix for rendering MapInfoWindow aka  map bubble
 	 */
-	private static $map_info_window_suffix = '_MapInfoWindow';
-
-	private static $db = array(
-		'Lat' => 'Decimal(18,15)',
-		'Lon' => 'Decimal(18,15)',
-		'ZoomLevel' => 'Int',
-		'MapPinEdited' => 'Boolean'
-	);
-
-	static $has_one = array(
-		'MapPinIcon' => 'Image'
-	);
-
-	static $defaults = array (
-		'Lat' =>0,
-		'Lon' => 0,
-		'Zoom' => 4,
-		'MapPinEdited' => false
-	);
-
-	/*
+    private static $map_info_window_suffix = '_MapInfoWindow';
+
+    private static $db = array(
+        'Lat' => 'Decimal(18,15)',
+        'Lon' => 'Decimal(18,15)',
+        'ZoomLevel' => 'Int',
+        'MapPinEdited' => 'Boolean'
+    );
+
+    static $has_one = array(
+        'MapPinIcon' => 'Image'
+    );
+
+    static $defaults = array (
+        'Lat' =>0,
+        'Lon' => 0,
+        'Zoom' => 4,
+        'MapPinEdited' => false
+    );
+
+    /*
 	Map editing field
 	 */
-	private $mapField = null;
+    private $mapField = null;
 
 
-	/*
+    /*
 	Add a Location tab containing the map
 	*/
-	public function updateCMSFields(FieldList $fields) {
-		// These fields need removed, as they may have already been created by the form scaffolding
-		$fields->removeByName('Lat');
-		$fields->removeByName('Lon');
-		$fields->removeByName('ZoomLevel');
-		$fields->removeByName('MapPinIcon');
-		$fields->removeByName('MapPinEdited');
-
-		$fields->addFieldToTab("Root.Location",
-			$this->getMapField()
-		);
-
-		$fields->addFieldToTab('Root.Location', $uf = new UploadField('MapPinIcon',
-			_t('Mappable.MAP_PIN', 'Map Pin Icon.  Leave this blank for default pin to show')));
-		$uf->setFolderName('mapicons');
-	}
-
-
-	public function getMappableLatitude() {
-		return $this->owner->Lat;
-	}
-
-	public function getMappableLongitude() {
-		return $this->owner->Lon;
-	}
-
-
-	/**
-	 * Renders the map info window for the DataObject.
-	 *
-	 * Be sure to define a template for that, named by the decorated class suffixed with _MapInfoWindow
-	 * e.g. MyPage_MapInfoWindow
-	 *
-	 * You can change the suffix globally by editing the MapExtension.map_info_window_suffix config val
-	 *
-	 * @return string
-	 */
-	public function getMappableMapContent() {
-		$defaultTemplate = 'MapInfoWindow';
-		$classTemplate =
-			SSViewer::get_templates_by_class(
-				$this->owner->ClassName,
-				Config::inst()->get('MapExtension', 'map_info_window_suffix')
-			);
-
-		$template = count($classTemplate) ? $classTemplate : $defaultTemplate;
-		return MapUtil::sanitize($this->owner->renderWith($template));
-	}
-
-
-	/*
+    public function updateCMSFields(FieldList $fields) {
+        // These fields need removed, as they may have already been created by the form scaffolding
+        $fields->removeByName('Lat');
+        $fields->removeByName('Lon');
+        $fields->removeByName('ZoomLevel');
+        $fields->removeByName('MapPinIcon');
+        $fields->removeByName('MapPinEdited');
+
+        $fields->addFieldToTab("Root.Location",
+            $this->getMapField()
+        );
+
+        $fields->addFieldToTab('Root.Location', $uf = new UploadField('MapPinIcon',
+            _t('Mappable.MAP_PIN', 'Map Pin Icon.  Leave this blank for default pin to show')));
+        $uf->setFolderName('mapicons');
+    }
+
+
+    public function getMappableLatitude() {
+        return $this->owner->Lat;
+    }
+
+    public function getMappableLongitude() {
+        return $this->owner->Lon;
+    }
+
+
+    /**
+     * Renders the map info window for the DataObject.
+     *
+     * Be sure to define a template for that, named by the decorated class suffixed with _MapInfoWindow
+     * e.g. MyPage_MapInfoWindow
+     *
+     * You can change the suffix globally by editing the MapExtension.map_info_window_suffix config val
+     *
+     * @return string
+     */
+    public function getMappableMapContent() {
+        $defaultTemplate = 'MapInfoWindow';
+        $classTemplate =
+            SSViewer::get_templates_by_class(
+                $this->owner->ClassName,
+                Config::inst()->get('MapExtension', 'map_info_window_suffix')
+            );
+
+        $template = count($classTemplate) ? $classTemplate : $defaultTemplate;
+        return MapUtil::sanitize($this->owner->renderWith($template));
+    }
+
+
+    /*
 	If the marker pin is not at position 0,0 mark the pin as edited. This provides the option of
 	filtering out (0,0) point which is often irrelevant for plots
 	*/
-	public function onBeforeWrite() {
-		$latzero = ($this->owner->Lat == 0);
-		$lonzero = ($this->owner->Lon == 0);
-		$latlonzero = $latzero && $lonzero;
-
-		// if both latitude and longitude still default, do not set the map location as edited
-		if (!$latlonzero) {
-		  $this->owner->MapPinEdited = true;
-		}
-	}
+    public function onBeforeWrite() {
+        $latzero = ($this->owner->Lat == 0);
+        $lonzero = ($this->owner->Lon == 0);
+        $latlonzero = $latzero && $lonzero;
+
+        // if both latitude and longitude still default, do not set the map location as edited
+        if (!$latlonzero) {
+            $this->owner->MapPinEdited = true;
+        }
+    }
 
 
-	/*
+    /*
 	If a user has uploaded a map pin icon display that, otherwise
 	*/
-	public function getMappableMapPin() {
-		$result = false;
-		if ($this->owner->MapPinIconID != 0) {
-			$mapPin = $this->owner->MapPinIcon();
-			$result = $mapPin->getAbsoluteURL();
-		} else {
-		  // check for a cached map pin already having been provided for the layer
-			if ($this->owner->CachedMapPinURL) {
-				$result = $this->owner->CachedMapPinURL;
-		  	}
-		}
-		return $result;
-	}
-
-
-	/*
+    public function getMappableMapPin() {
+        $result = false;
+        if ($this->owner->MapPinIconID != 0) {
+            $mapPin = $this->owner->MapPinIcon();
+            $result = $mapPin->getAbsoluteURL();
+        } else {
+            // check for a cached map pin already having been provided for the layer
+            if ($this->owner->CachedMapPinURL) {
+                $result = $this->owner->CachedMapPinURL;
+                }
+        }
+        return $result;
+    }
+
+
+    /*
 		Check for non zero coordinates, on the assumption that (0,0) will never be the desired coordinates
 	*/
-	public function HasGeo() {
-		$isOrigin = ($this->owner->Lat == 0) && ($this->owner->Lon == 0);
-		$result = !$isOrigin;
-		if ($this->owner->hasExtension('MapLayerExtension')) {
-			if ($this->owner->MapLayers()->count() > 0) {
-				$result = true;
-			}
-		}
-
-
-		$this->owner->extend('updateHasGeo', $result);
-		/**
-		 * FIXME - move this to PointsOfInterest module
+    public function HasGeo() {
+        $isOrigin = ($this->owner->Lat == 0) && ($this->owner->Lon == 0);
+        $result = !$isOrigin;
+        if ($this->owner->hasExtension('MapLayerExtension')) {
+            if ($this->owner->MapLayers()->count() > 0) {
+                $result = true;
+            }
+        }
+
+
+        $this->owner->extend('updateHasGeo', $result);
+        /**
+         * FIXME - move this to PointsOfInterest module
 		if ($this->owner->hasExtension('PointsOfInterestLayerExtension')) {
 			if ($this->owner->PointsOfInterestLayers()->count() > 0) {
 				$result = true;
 			}
 		}
-		 */
+         */
 
-		return $result;
-	}
+        return $result;
+    }
 
 
-	/*
+    /*
 	Render a map at the provided lat,lon, zoom from the editing functions,
 	*/
-	public function BasicMap() {
-		$map = $this->owner->getRenderableMap()->
-			setZoom($this->owner->ZoomLevel)->
-			setAdditionalCSSClasses('fullWidthMap')->
-			setShowInlineMapDivStyle(true);
-
-		$autozoom = false;
-
-		// add any KML map layers
-		if (Object::has_extension($this->owner->ClassName, 'MapLayerExtension')) {
-		  foreach($this->owner->MapLayers() as $layer) {
-			$map->addKML($layer->KmlFile()->getAbsoluteURL());
-			// we have a layer, so turn on autozoom
-			$autozoom = true;
-		  }
-			$map->setEnableAutomaticCenterZoom(true);
-		}
-
-		$this->owner->extend('updateBasicMap', $map);
-
-		/**
+    public function BasicMap() {
+        $map = $this->owner->getRenderableMap()->
+            setZoom($this->owner->ZoomLevel)->
+            setAdditionalCSSClasses('fullWidthMap')->
+            setShowInlineMapDivStyle(true);
+
+        $autozoom = false;
+
+        // add any KML map layers
+        if (Object::has_extension($this->owner->ClassName, 'MapLayerExtension')) {
+            foreach($this->owner->MapLayers() as $layer) {
+            $map->addKML($layer->KmlFile()->getAbsoluteURL());
+            // we have a layer, so turn on autozoom
+            $autozoom = true;
+            }
+            $map->setEnableAutomaticCenterZoom(true);
+        }
+
+        $this->owner->extend('updateBasicMap', $map);
+
+        /**
 		FIXME - move to POI module
 		if (Object::has_extension($this->owner->ClassName, 'PointsOfInterestLayerExtension')) {
 			foreach($this->owner->PointsOfInterestLayers() as $layer) {
@@ -190,37 +190,36 @@ 
 			}
 			$map->setClusterer(true);
 		}
-
-		**/
-
-		$map->setEnableAutomaticCenterZoom($autozoom);
-		$map->setShowInlineMapDivStyle(true);
-
-		return $map;
-	}
-
-
-	/**
-	 * Access the map editing field for the purpose of adding guide points
-	 * @return [LatLongField] instance of location editing field
-	 */
-	public function getMapField() {
-		if (!isset($this->mapField)) {
-			$this->mapField = new LatLongField(array(
-				new TextField('Lat', 'Latitude'),
-				new TextField('Lon', 'Longitude'),
-				new TextField('ZoomLevel', 'Zoom')
-				)
-			);
-		}
-		return $this->mapField;
-	}
-
-
-	/**
-	 * Template helper, used to decide whether or not to use compressed assets
-	 */
-	public function UseCompressedAssets() {
-		return Config::inst()->get('Mappable', 'use_compressed_assets');
-	}
+         **/
+
+        $map->setEnableAutomaticCenterZoom($autozoom);
+        $map->setShowInlineMapDivStyle(true);
+
+        return $map;
+    }
+
+
+    /**
+     * Access the map editing field for the purpose of adding guide points
+     * @return [LatLongField] instance of location editing field
+     */
+    public function getMapField() {
+        if (!isset($this->mapField)) {
+            $this->mapField = new LatLongField(array(
+                new TextField('Lat', 'Latitude'),
+                new TextField('Lon', 'Longitude'),
+                new TextField('ZoomLevel', 'Zoom')
+                )
+            );
+        }
+        return $this->mapField;
+    }
+
+
+    /**
+     * Template helper, used to decide whether or not to use compressed assets
+     */
+    public function UseCompressedAssets() {
+        return Config::inst()->get('Mappable', 'use_compressed_assets');
+    }
 }

code/shortcodes/GoogleStreetViewShortCodeHandler.php

Spacing +3 added lines, -3 removed lines

@@ -8,15 +8,15 @@
 
 	public static function parse_googlestreetview($arguments, $caption = null, $parser = null) {
 		// each of latitude, longitude and heading are required at a bare minimum
-		if(!isset($arguments['latitude'])){
+		if (!isset($arguments['latitude'])) {
 			return '';
 		}
 
-		if(!isset($arguments['longitude'])){
+		if (!isset($arguments['longitude'])) {
 			return '';
 		}
 
-		if(!isset($arguments['heading'])){
+		if (!isset($arguments['heading'])) {
 			return '';
 		}
 

Indentation +56 added lines, -56 removed lines

@@ -2,78 +2,78 @@
 
 class GoogleStreetViewShortCodeHandler {
 
-	/* Counter used to ensure unique div ids to allow for multiple StreetViews on on page */
-	private static $gsv_ctr = 1;
+    /* Counter used to ensure unique div ids to allow for multiple StreetViews on on page */
+    private static $gsv_ctr = 1;
 
 
-	public static function parse_googlestreetview($arguments, $caption = null, $parser = null) {
-		// each of latitude, longitude and heading are required at a bare minimum
-		if(!isset($arguments['latitude'])){
-			return '';
-		}
+    public static function parse_googlestreetview($arguments, $caption = null, $parser = null) {
+        // each of latitude, longitude and heading are required at a bare minimum
+        if(!isset($arguments['latitude'])){
+            return '';
+        }
 
-		if(!isset($arguments['longitude'])){
-			return '';
-		}
+        if(!isset($arguments['longitude'])){
+            return '';
+        }
 
-		if(!isset($arguments['heading'])){
-			return '';
-		}
+        if(!isset($arguments['heading'])){
+            return '';
+        }
 
-		// defaults - these can be overriden by using zoom and pitch in the shortcode
-		$defaults = array(
-			'Zoom' => 1,
-			'Pitch' => 0
-		);
+        // defaults - these can be overriden by using zoom and pitch in the shortcode
+        $defaults = array(
+            'Zoom' => 1,
+            'Pitch' => 0
+        );
 
-		// ensure JavaScript for the map service is only downloaded once
-		$arguments['DownloadJS'] = !MapUtil::get_map_already_rendered();
-		MapUtil::set_map_already_rendered(true);
+        // ensure JavaScript for the map service is only downloaded once
+        $arguments['DownloadJS'] = !MapUtil::get_map_already_rendered();
+        MapUtil::set_map_already_rendered(true);
 
-		// convert parameters to CamelCase as per standard template conventions
-		$arguments['Latitude'] = $arguments['latitude'];
-		$arguments['Longitude'] = $arguments['longitude'];
-		$arguments['Heading'] = $arguments['heading'];
+        // convert parameters to CamelCase as per standard template conventions
+        $arguments['Latitude'] = $arguments['latitude'];
+        $arguments['Longitude'] = $arguments['longitude'];
+        $arguments['Heading'] = $arguments['heading'];
 
-		// optional parameter caption
-		if (isset($arguments['caption'])) {
-			$arguments['Caption'] = $arguments['caption'];
-		}
+        // optional parameter caption
+        if (isset($arguments['caption'])) {
+            $arguments['Caption'] = $arguments['caption'];
+        }
 
-		// optional parameter pitch
-		if (isset($arguments['pitch'])) {
-			$arguments['Pitch'] = $arguments['pitch'];
-		}
+        // optional parameter pitch
+        if (isset($arguments['pitch'])) {
+            $arguments['Pitch'] = $arguments['pitch'];
+        }
 
-		// optional parameter zoom
-		if (isset($arguments['zoom'])) {
-			$arguments['Zoom'] = $arguments['zoom'];
-		}
+        // optional parameter zoom
+        if (isset($arguments['zoom'])) {
+            $arguments['Zoom'] = $arguments['zoom'];
+        }
 
-		// the id of the dom element to be used to render the street view
-		$arguments['DomID'] = 'google_streetview_'.self::$gsv_ctr;
+        // the id of the dom element to be used to render the street view
+        $arguments['DomID'] = 'google_streetview_'.self::$gsv_ctr;
 
-		// incrememt the counter to ensure a unique id for each map canvas
-		self::$gsv_ctr++;
+        // incrememt the counter to ensure a unique id for each map canvas
+        self::$gsv_ctr++;
 
-		// merge defaults and arguments
-		$customised = array_merge($defaults, $arguments);
+        // merge defaults and arguments
+        $customised = array_merge($defaults, $arguments);
 
-		// Include google maps JS at the end of the page
-		//Requirements::javascriptTemplate("mappable/javascript/google/streetview.google.template.js", $customised);
+        // Include google maps JS at the end of the page
+        //Requirements::javascriptTemplate("mappable/javascript/google/streetview.google.template.js", $customised);
 
 
-		//get streetview template template
-		$template = new SSViewer('GoogleStreetView');
+        //get streetview template template
+        $template = new SSViewer('GoogleStreetView');
 
-		//return the template customised with the parmameters
-		return $template->process(new ArrayData($customised));
-	}
+        //return the template customised with the parmameters
+        return $template->process(new ArrayData($customised));
+    }
 
-	/**
-	 * This is only used for testing, otherwise the sequence of tests change the number returned
-	 */
-	public static function resetCounter() {
-		self::$gsv_ctr = 1;
-	}
+    /**
+     * This is only used for testing, otherwise the sequence of tests change the number returned
+     */
+    public static function resetCounter() {
+        self::$gsv_ctr = 1;
+    }
 }

code/shortcodes/GoogleMapShortCodeHandler.php

Spacing +2 added lines, -2 removed lines

@@ -7,11 +7,11 @@
 
 	public static function parse_googlemap($arguments, $caption = null, $parser = null) {
 		// each of latitude and longitude are required at a bare minimum
-		if(!isset($arguments['latitude'])){
+		if (!isset($arguments['latitude'])) {
 			return '';
 		}
 
-		if(!isset($arguments['longitude'])){
+		if (!isset($arguments['longitude'])) {
 			return '';
 		}
 

Indentation +69 added lines, -69 removed lines

@@ -2,73 +2,73 @@
 
 class GoogleMapShortCodeHandler {
 
-	/* Counter used to ensure unique div ids to allow for multiple maps on on page */
-	private static $gsv_ctr = 1;
-
-	public static function parse_googlemap($arguments, $caption = null, $parser = null) {
-		// each of latitude and longitude are required at a bare minimum
-		if(!isset($arguments['latitude'])){
-			return '';
-		}
-
-		if(!isset($arguments['longitude'])){
-			return '';
-		}
-
-		// defaults - can be overriden by using zoom and FIXME in the shortcode
-		$defaults = array(
-			'Zoom' => 5,
-			'MapType' => 'road'
-		);
-
-		// ensure JavaScript for the map service is only downloaded once
-		$arguments['DownloadJS'] = !MapUtil::get_map_already_rendered();
-		MapUtil::set_map_already_rendered(true);
-
-		// convert parameters to CamelCase as per standard template conventions
-		$arguments['Latitude'] = $arguments['latitude'];
-		$arguments['Longitude'] = $arguments['longitude'];
-
-		// optional parameter caption
-		if (isset($arguments['caption'])) {
-			$arguments['Caption'] = $arguments['caption'];
-		}
-
-		if (isset($arguments['maptype'])) {
-			$arguments['MapType'] = $arguments['maptype'];
-		}
-
-		// optional parameter zoom
-		if (isset($arguments['zoom'])) {
-			$arguments['Zoom'] = $arguments['zoom'];
-		}
-
-		// the id of the dom element to be used to render the street view
-		$arguments['DomID'] = 'google_sc_map_'.self::$gsv_ctr;
-
-		// fullscreen
-		$arguments['AllowFullScreen'] = Config::inst()->get('Mappable', 'allow_full_screen');
-
-		// incrememt the counter to ensure a unique id for each map canvas
-		self::$gsv_ctr++;
-
-		// merge defaults and arguments
-		$customised = array_merge($defaults, $arguments);
-
-		// include JavaScript to be appended at the end of the page, namely params for map rendering
-		//Requirements::javascriptTemplate("mappable/javascript/google/map.google.template.js", $customised);
-
-		//get map view template and render the HTML
-		$template = new SSViewer('GoogleMapShortCode');
-
-		//return the template customised with the parmameters
-		return $template->process(new ArrayData($customised));
-	}
-
-	/**
-	 * This is only used for testing, otherwise the sequence of tests change the number returned
-	 */
-	public static function resetCounter() {
-		self::$gsv_ctr = 1;
-	}
+    /* Counter used to ensure unique div ids to allow for multiple maps on on page */
+    private static $gsv_ctr = 1;
+
+    public static function parse_googlemap($arguments, $caption = null, $parser = null) {
+        // each of latitude and longitude are required at a bare minimum
+        if(!isset($arguments['latitude'])){
+            return '';
+        }
+
+        if(!isset($arguments['longitude'])){
+            return '';
+        }
+
+        // defaults - can be overriden by using zoom and FIXME in the shortcode
+        $defaults = array(
+            'Zoom' => 5,
+            'MapType' => 'road'
+        );
+
+        // ensure JavaScript for the map service is only downloaded once
+        $arguments['DownloadJS'] = !MapUtil::get_map_already_rendered();
+        MapUtil::set_map_already_rendered(true);
+
+        // convert parameters to CamelCase as per standard template conventions
+        $arguments['Latitude'] = $arguments['latitude'];
+        $arguments['Longitude'] = $arguments['longitude'];
+
+        // optional parameter caption
+        if (isset($arguments['caption'])) {
+            $arguments['Caption'] = $arguments['caption'];
+        }
+
+        if (isset($arguments['maptype'])) {
+            $arguments['MapType'] = $arguments['maptype'];
+        }
+
+        // optional parameter zoom
+        if (isset($arguments['zoom'])) {
+            $arguments['Zoom'] = $arguments['zoom'];
+        }
+
+        // the id of the dom element to be used to render the street view
+        $arguments['DomID'] = 'google_sc_map_'.self::$gsv_ctr;
+
+        // fullscreen
+        $arguments['AllowFullScreen'] = Config::inst()->get('Mappable', 'allow_full_screen');
+
+        // incrememt the counter to ensure a unique id for each map canvas
+        self::$gsv_ctr++;
+
+        // merge defaults and arguments
+        $customised = array_merge($defaults, $arguments);
+
+        // include JavaScript to be appended at the end of the page, namely params for map rendering
+        //Requirements::javascriptTemplate("mappable/javascript/google/map.google.template.js", $customised);
+
+        //get map view template and render the HTML
+        $template = new SSViewer('GoogleMapShortCode');
+
+        //return the template customised with the parmameters
+        return $template->process(new ArrayData($customised));
+    }
+
+    /**
+     * This is only used for testing, otherwise the sequence of tests change the number returned
+     */
+    public static function resetCounter() {
+        self::$gsv_ctr = 1;
+    }
 }

code/MappableDataObjectSet.php

Spacing +1 added lines, -1 removed lines

@@ -27,7 +27,7 @@
 		$gmap = MapUtil::get_map($this->owner, $this->MarkerTemplateValues);
 		$w = $width ? $width : MapUtil::$map_width;
 		$h = $height ? $height : MapUtil::$map_height;
-		$gmap->setSize($w,$h);
+		$gmap->setSize($w, $h);
 		return $gmap;
 	}
 

Indentation +20 added lines, -20 removed lines

@@ -8,27 +8,27 @@
  */
 class MappableDataObjectSet extends Extension {
 
-	/**
-	 * Optional template values for the map info windows
-	 */
-	private $MarkerTemplateValues = null;
+    /**
+     * Optional template values for the map info windows
+     */
+    private $MarkerTemplateValues = null;
 
-	/**
-	 * Pass through values to the markers so that when rendering the map info windows, these
-	 * parameters are available to the template.  This is of course optional
-	 *
-	 * @param array $values hash array of template key to template value
-	 */
-	public function setMarkerTemplateValues($values) {
-		$this->MarkerTemplateValues = $values;
-	}
+    /**
+     * Pass through values to the markers so that when rendering the map info windows, these
+     * parameters are available to the template.  This is of course optional
+     *
+     * @param array $values hash array of template key to template value
+     */
+    public function setMarkerTemplateValues($values) {
+        $this->MarkerTemplateValues = $values;
+    }
 
-	public function getRenderableMap($width = null, $height = null) {
-		$gmap = MapUtil::get_map($this->owner, $this->MarkerTemplateValues);
-		$w = $width ? $width : MapUtil::$map_width;
-		$h = $height ? $height : MapUtil::$map_height;
-		$gmap->setSize($w,$h);
-		return $gmap;
-	}
+    public function getRenderableMap($width = null, $height = null) {
+        $gmap = MapUtil::get_map($this->owner, $this->MarkerTemplateValues);
+        $w = $width ? $width : MapUtil::$map_width;
+        $h = $height ? $height : MapUtil::$map_height;
+        $gmap->setSize($w,$h);
+        return $gmap;
+    }
 
 }

code/MappableData.php

Spacing +2 added lines, -2 removed lines

@@ -40,7 +40,7 @@ 
 		$gmap = MapUtil::get_map(new ArrayList(array($this->owner)), $this->MarkerTemplateValues);
 		$w = $width ? $width : MapUtil::$map_width;
 		$h = $height ? $height : MapUtil::$map_height;
-		$gmap->setSize($w,$h);
+		$gmap->setSize($w, $h);
 		$gmap->setZoom($zoom);
 		$gmap->setEnableAutomaticCenterZoom(false);
 		if ($this->owner->MapPinEdited) {
@@ -89,7 +89,7 @@ 
 			$urlparts['markers'] = "icon:$pin|$lat,$lng";
 		}
 
-		$src = htmlentities($apiurl . '?' . http_build_query($urlparts));
+		$src = htmlentities($apiurl.'?'.http_build_query($urlparts));
 		return '<img src="'.$src.'" width="'.$w.'" height="'.$h.'" alt="'.$this->owner->Title.'" />';
 	}
 

Indentation +88 added lines, -88 removed lines

@@ -8,93 +8,93 @@
  */
 class MappableData extends Extension {
 
-	/**
-	 * Optional template values for the map info windows
-	 */
-	private $MarkerTemplateValues = null;
-
-	/**
-	 * URL of static maps api
-	 * @var string
-	 */
-	private static $staticmap_api_url = '//maps.googleapis.com/maps/api/staticmap';
-
-	/**
-	 * Default zoom for static map
-	 * @var int
-	 */
-	private static $staticmap_default_zoom = 13;
-
-	/**
-	 * Pass through values to the markers so that when rendering the map info windows, these
-	 * parameters are available to the template.  This is of course optional
-	 *
-	 * @param array $values hash array of template key to template value
-	 */
-	public function setMarkerTemplateValues($values) {
-		$this->MarkerTemplateValues = $values;
-	}
-
-
-	public function getRenderableMap($width = null, $height = null, $zoom = 9) {
-		$gmap = MapUtil::get_map(new ArrayList(array($this->owner)), $this->MarkerTemplateValues);
-		$w = $width ? $width : MapUtil::$map_width;
-		$h = $height ? $height : MapUtil::$map_height;
-		$gmap->setSize($w,$h);
-		$gmap->setZoom($zoom);
-		$gmap->setEnableAutomaticCenterZoom(false);
-		if ($this->owner->MapPinEdited) {
-			$gmap->setLatLongCenter(array(
-				'lat' => $this->owner->getMappableLatitude(),
-				'lng' => $this->owner->getMappableLongitude()
-			));
-		}
-		return $gmap;
-	}
-
-
-	/**
-	 * returns an <img> with a src set to a static map picture
-	 *
-	 * You can use MappableData.staticmap_api_url config var to set the domain of the static map.
-	 * You can use MappableData.staticmap_default_zoom config var to set the default zoom for the static map.
-	 *
-	 * @uses Mappable::getMappableMapPin() to draw a special marker, be sure this image is publicly available
-	 *
-	 * @param int $width
-	 * @param int $height
-	 * @return string
-	 */
-	public function StaticMap($width, $height, $zoom = null, $mapType = 'roadmap') {
-		$lat = $this->owner->getMappableLatitude();
-		$lng = $this->owner->getMappableLongitude();
-		$pin = $this->owner->getMappableMapPin();
-
-		// use provided zoom or set a default
-		if ($zoom == null) {
-			$zoom = Config::inst()->get('MappableData', 'staticmap_default_zoom');
-		}
-
-		//https://maps.googleapis.com/maps/api/staticmap?center=Berkeley,CA&zoom=14&size=400x400&key=YOUR_API_KEY
-			    //maps.googleapis.com/maps/api/staticmap';
-
-		$apiurl = Config::inst()->get('MappableData', 'staticmap_api_url');
-
-		$urlparts = array(
-			'center' => "$lat,$lng",
-			'markers' => "$lat,$lng",
-			'zoom' => $zoom,
-			'size' => "{$width}x{$height}",
-			'sensor' => 'false', //@todo: make sensor param configurable
-			'maptype' => $mapType
-		);
-		if ($pin) {
-			$urlparts['markers'] = "icon:$pin|$lat,$lng";
-		}
-
-		$src = htmlentities($apiurl . '?' . http_build_query($urlparts));
-
-		return '<img src="'.$src.'" width="'.$width.'" height="'.$height.'" alt="'.$this->owner->Title.'" />';
-	}
+    /**
+     * Optional template values for the map info windows
+     */
+    private $MarkerTemplateValues = null;
+
+    /**
+     * URL of static maps api
+     * @var string
+     */
+    private static $staticmap_api_url = '//maps.googleapis.com/maps/api/staticmap';
+
+    /**
+     * Default zoom for static map
+     * @var int
+     */
+    private static $staticmap_default_zoom = 13;
+
+    /**
+     * Pass through values to the markers so that when rendering the map info windows, these
+     * parameters are available to the template.  This is of course optional
+     *
+     * @param array $values hash array of template key to template value
+     */
+    public function setMarkerTemplateValues($values) {
+        $this->MarkerTemplateValues = $values;
+    }
+
+
+    public function getRenderableMap($width = null, $height = null, $zoom = 9) {
+        $gmap = MapUtil::get_map(new ArrayList(array($this->owner)), $this->MarkerTemplateValues);
+        $w = $width ? $width : MapUtil::$map_width;
+        $h = $height ? $height : MapUtil::$map_height;
+        $gmap->setSize($w,$h);
+        $gmap->setZoom($zoom);
+        $gmap->setEnableAutomaticCenterZoom(false);
+        if ($this->owner->MapPinEdited) {
+            $gmap->setLatLongCenter(array(
+                'lat' => $this->owner->getMappableLatitude(),
+                'lng' => $this->owner->getMappableLongitude()
+            ));
+        }
+        return $gmap;
+    }
+
+
+    /**
+     * returns an <img> with a src set to a static map picture
+     *
+     * You can use MappableData.staticmap_api_url config var to set the domain of the static map.
+     * You can use MappableData.staticmap_default_zoom config var to set the default zoom for the static map.
+     *
+     * @uses Mappable::getMappableMapPin() to draw a special marker, be sure this image is publicly available
+     *
+     * @param int $width
+     * @param int $height
+     * @return string
+     */
+    public function StaticMap($width, $height, $zoom = null, $mapType = 'roadmap') {
+        $lat = $this->owner->getMappableLatitude();
+        $lng = $this->owner->getMappableLongitude();
+        $pin = $this->owner->getMappableMapPin();
+
+        // use provided zoom or set a default
+        if ($zoom == null) {
+            $zoom = Config::inst()->get('MappableData', 'staticmap_default_zoom');
+        }
+
+        //https://maps.googleapis.com/maps/api/staticmap?center=Berkeley,CA&zoom=14&size=400x400&key=YOUR_API_KEY
+                //maps.googleapis.com/maps/api/staticmap';
+
+        $apiurl = Config::inst()->get('MappableData', 'staticmap_api_url');
+
+        $urlparts = array(
+            'center' => "$lat,$lng",
+            'markers' => "$lat,$lng",
+            'zoom' => $zoom,
+            'size' => "{$width}x{$height}",
+            'sensor' => 'false', //@todo: make sensor param configurable
+            'maptype' => $mapType
+        );
+        if ($pin) {
+            $urlparts['markers'] = "icon:$pin|$lat,$lng";
+        }
+
+        $src = htmlentities($apiurl . '?' . http_build_query($urlparts));
+
+        return '<img src="'.$src.'" width="'.$width.'" height="'.$height.'" alt="'.$this->owner->Title.'" />';
+    }
 
 }

code/MapUtil.php

Braces +3 added lines, -2 removed lines

@@ -226,8 +226,9 @@
 		$gmap = self::instance();
 		if ($list) {
 			foreach ($list as $mappable) {
-				if (self::ChooseToAddDataobject($mappable))
-					$gmap->addMarkerAsObject($mappable, $infowindowtemplateparams);
+				if (self::ChooseToAddDataobject($mappable)) {
+									$gmap->addMarkerAsObject($mappable, $infowindowtemplateparams);
+				}
 			}
 		}
 		return $gmap;

Indentation +217 added lines, -217 removed lines

@@ -3,221 +3,221 @@
 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%';
-		self::$map_height = '400px';
-		self::$div_id = "google_map";
-		self::$automatic_center = true;
-		self::$hide_marker = false;
-		self::$map_type = 'google.maps.MapTypeId.ROADMAP';
-		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 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;
-	}
-
-	/**
-	 * 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);
-		$gmap->setSize(self::$map_width, self::$map_height);
-		$gmap->setDefaultHideMarker(self::$hide_marker);
-		$gmap->setMapType(self::$map_type);
-		$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;
-	}
+    /**
+     * @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%';
+        self::$map_height = '400px';
+        self::$div_id = "google_map";
+        self::$automatic_center = true;
+        self::$hide_marker = false;
+        self::$map_type = 'google.maps.MapTypeId.ROADMAP';
+        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 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;
+    }
+
+    /**
+     * 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);
+        $gmap->setSize(self::$map_width, self::$map_height);
+        $gmap->setDefaultHideMarker(self::$hide_marker);
+        $gmap->setMapType(self::$map_type);
+        $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;
+    }
 }

tests/MapExtensionTest.php

Doc Comments +7 added lines

@@ -256,6 +256,10 @@ 
 	/*
 	Add a map layer to an existing instance
 	 */
+
+	/**
+	 * @param Member $instance
+	 */
 	private function addLayerToInstance(&$instance) {
 		// Create a layer
 		$kmlFile = new File(array('Name' => 'example.kml', 'Filename' => 'mappable/tests/kml/example.kml'));
@@ -269,6 +273,9 @@ 
 		$layers->add($layer);
 	}
 
+	/**
+	 * @param Member $instance
+	 */
 	private function addMapPinToInstance(&$instance) {
 		// Create a pin
 		$imageFile = new Image(array('Name' => 'mapicontest.png', 'Filename' => 'mappable/tests/images/mapicontest.png'));

Indentation +251 added lines, -251 removed lines

@@ -1,294 +1,294 @@
 <?php
 
 class MapExtensionTest extends SapphireTest {
-	protected static $fixture_file = 'mappable/tests/mapextensions.yml';
+    protected static $fixture_file = 'mappable/tests/mapextensions.yml';
 
-	public function setUpOnce() {
-		$this->requiredExtensions = array(
-			'Member' => array('MapExtension', 'MapLayerExtension')
-		);
-		parent::setupOnce();
-	}
+    public function setUpOnce() {
+        $this->requiredExtensions = array(
+            'Member' => array('MapExtension', 'MapLayerExtension')
+        );
+        parent::setupOnce();
+    }
 
 
-	public function testUpdateCMSFields() {
+    public function testUpdateCMSFields() {
 
-	}
+    }
 
 
-	public function testGetMappableLatitude() {
-		$instance = $this->getInstance();
-		$instance->Lat = 42.1;
-		$instance->write();
-		$this->assertEquals(
-			42.1,
-			$instance->getMappableLatitude()
-		);
-	}
+    public function testGetMappableLatitude() {
+        $instance = $this->getInstance();
+        $instance->Lat = 42.1;
+        $instance->write();
+        $this->assertEquals(
+            42.1,
+            $instance->getMappableLatitude()
+        );
+    }
 
 
-	public function testGetMappableLongitude() {
-		$instance = $this->getInstance();
-		$instance->Lon = 42.1;
-		$this->assertEquals(
-			42.1,
-			$instance->getMappableLongitude()
-		);
-	}
+    public function testGetMappableLongitude() {
+        $instance = $this->getInstance();
+        $instance->Lon = 42.1;
+        $this->assertEquals(
+            42.1,
+            $instance->getMappableLongitude()
+        );
+    }
 
 
-	public function testgetMappableMapContent() {
+    public function testgetMappableMapContent() {
 
-	}
+    }
 
 
-	public function testonBeforeWriteMapPinNotEdited() {
-		$instance = $this->getInstance();
-		$this->Lat = 0;
-		$this->Lon = 0;
-		$instance->write();
-		$this->assertFalse($instance->MapPinEdited);
-	}
+    public function testonBeforeWriteMapPinNotEdited() {
+        $instance = $this->getInstance();
+        $this->Lat = 0;
+        $this->Lon = 0;
+        $instance->write();
+        $this->assertFalse($instance->MapPinEdited);
+    }
 
-	public function testonBeforeWriteMapPinEdited() {
-		$instance = $this->getInstance();
+    public function testonBeforeWriteMapPinEdited() {
+        $instance = $this->getInstance();
 
-		// north
-		$this->showMapPinEdited($instance, 10, 0);
+        // north
+        $this->showMapPinEdited($instance, 10, 0);
 
-		// north west
-		$this->showMapPinEdited($instance, 10, -10);
+        // north west
+        $this->showMapPinEdited($instance, 10, -10);
 
-		// west
-		$this->showMapPinEdited($instance, 0, -10);
+        // west
+        $this->showMapPinEdited($instance, 0, -10);
 
-		// south west
-		$this->showMapPinEdited($instance, -10, -10);
+        // south west
+        $this->showMapPinEdited($instance, -10, -10);
 
-		// south
-		$this->showMapPinEdited($instance, -10, 0);
+        // south
+        $this->showMapPinEdited($instance, -10, 0);
 
-		// south east
-		$this->showMapPinEdited($instance, -10, 10);
+        // south east
+        $this->showMapPinEdited($instance, -10, 10);
 
-		// east
-		$this->showMapPinEdited($instance, 0, 10);
+        // east
+        $this->showMapPinEdited($instance, 0, 10);
 
-		// north east
-		$this->showMapPinEdited($instance, 10, 10);
+        // north east
+        $this->showMapPinEdited($instance, 10, 10);
 
-	}
+    }
 
 
-	// FIXME - use an actual file here
-	public function testGetMappableMapPin() {
-		$instance = $this->getInstance();
+    // FIXME - use an actual file here
+    public function testGetMappableMapPin() {
+        $instance = $this->getInstance();
 
-		// no icon, so return false
-		$this->assertFalse($instance->getMappableMapPin());
+        // no icon, so return false
+        $this->assertFalse($instance->getMappableMapPin());
 
-		// add a default map icon
-		$this->addMapPinToInstance($instance);
+        // add a default map icon
+        $this->addMapPinToInstance($instance);
 
-		$pin1 = $instance->getMappableMapPin();
-		$this->assertStringEndsWith('assets/mapicontest.png', $pin1);
+        $pin1 = $instance->getMappableMapPin();
+        $this->assertStringEndsWith('assets/mapicontest.png', $pin1);
 
-		// Test the cached pin - this is the case of a layer providing a cached pin
-		// so that repeated calls are not made to load the same icon
-		$iconURL =
-			'https://cdn3.iconfinder.com/data/icons/iconic-1/32/map_pin_fill-512.png';
+        // Test the cached pin - this is the case of a layer providing a cached pin
+        // so that repeated calls are not made to load the same icon
+        $iconURL =
+            'https://cdn3.iconfinder.com/data/icons/iconic-1/32/map_pin_fill-512.png';
 
-		// Set mappable as having no icon, use the cached one instead
-		// This simulates using a common icon to avoid DB queries
-		$instance->MapPinIconID = 0;
-		$instance->write();
-		$instance->CachedMapPinURL = $iconURL;
-		$pin2 = $instance->getMappableMapPin();
-		$this->assertEquals($iconURL, $pin2);
-	}
+        // Set mappable as having no icon, use the cached one instead
+        // This simulates using a common icon to avoid DB queries
+        $instance->MapPinIconID = 0;
+        $instance->write();
+        $instance->CachedMapPinURL = $iconURL;
+        $pin2 = $instance->getMappableMapPin();
+        $this->assertEquals($iconURL, $pin2);
+    }
 
 
 
 
 
-	public function testHasGeoWest() {
-		$instance = $this->getInstance();
-		$instance->Lon = -20;
-		$this->assertTrue($instance->HasGeo());
-	}
-
-	public function testHasGeoEast() {
-		$instance = $this->getInstance();
-		$instance->Lon = 20;
-		$this->assertTrue($instance->HasGeo());
-	}
-
-	public function testHasGeoNorth() {
-		$instance = $this->getInstance();
-		$instance->Lat = 20;
-		$this->assertTrue($instance->HasGeo());
-	}
-
-	public function testHasGeoNorthWest() {
-		$instance = $this->getInstance();
-		$instance->Lat = 20;
-		$instance->Lon = -20;
-		$this->assertTrue($instance->HasGeo());
-	}
-
-	public function testHasGeoNortEast() {
-		$instance = $this->getInstance();
-		$instance->Lat = 20;
-		$instance->Lon = 20;
-		$this->assertTrue($instance->HasGeo());
-	}
-
-	public function testHasGeoSouth() {
-		$instance = $this->getInstance();
-		$instance->Lat = -20;
-		$this->assertTrue($instance->HasGeo());
-	}
-
-	public function testHasGeoSouthWest() {
-		$instance = $this->getInstance();
-		$instance->Lat = -20;
-		$instance->Lon = -20;
-		$this->assertTrue($instance->HasGeo());
-	}
-
-	public function testHasGeoSouthEast() {
-		$instance = $this->getInstance();
-		$instance->Lat = -20;
-		$instance->Lon = 20;
-		$this->assertTrue($instance->HasGeo());
-	}
-
-	public function testHasGeoOrigin() {
-		$instance = $this->getInstance();
-		$instance->Lat = 0;
-		$instance->Lon = 0;
-		$this->assertFalse($instance->HasGeo());
-	}
-
-	public function testHasGeoOriginMapLayerExtension() {
-		$instance = $this->getInstance();
-
-		// assert that origin has no geo (until layers added)
-		$instance->Lat = 0;
-		$instance->Lon = 0;
-		$this->assertFalse($instance->HasGeo());
-
-		$this->addLayerToInstance($instance);
-
-		// assert has geo even when at the origin of 0,0
-		$this->assertTrue($instance->HasGeo());
-	}
-
-	public function testBasicMap() {
-		$instance = $this->getInstance();
-		$instance->Lat = 37.1;
-		$instance->Lon = 28;
-		$instance->Zoom = 12;
-		$instance->MapPinEdited = true;
-		$html = $instance->BasicMap()->forTemplate();
-
-		$expected = "data-centre='{\"lat\":37.1,\"lng\":28}'";
-		$this->assertContains($expected, $html);
-		$expected = "data-mapmarkers='[{\"latitude\":37.1,\"longitude\":28,\"html\":\"MEMBER: \",\"category\":\"default\",\"icon\":false}]'";
-		$this->assertContains($expected, $html);
-
-		// This is only set automatically with layers
-		$expected = 'data-enableautocentrezoom=false';
-		$this->assertContains($expected, $html);
-	}
-
-	public function testBasicMapWithLayer() {
-		$instance = $this->getInstance();
-		$instance->Lat = 37.1;
-		$instance->Lon = 28;
-		$instance->Zoom = 12;
-		$instance->MapPinEdited = true;
-		$instance->write();
-		$this->addLayerToInstance($instance);
-		$html = $instance->BasicMap()->forTemplate();
-
-		$expected = "data-centre='{\"lat\":37.1,\"lng\":28}'";
-		$this->assertContains($expected, $html);
-		$expected = "data-mapmarkers='[{\"latitude\":37.1,\"longitude\":28,\"html\":\"MEMBER: \",\"category\":\"default\",\"icon\":false}]'";
-		$this->assertContains($expected, $html);
-
-		// This is only set automatically with layers
-		$expected = 'data-enableautocentrezoom=1';
-		$this->assertContains($expected, $html);
-	}
-
-
-	public function testGetMapField() {
-		$instance = $this->getInstance();
-		$this->Lat = 37.1;
-		$this->Lon = 28;
-		$this->Zoom = 12;
-		$mapField  = $instance->getMapField();
-		$this->assertInstanceOf('LatLongField', $mapField);
-	}
-
-
-	public function testUseCompressedAssets() {
-		$original = Config::inst()->get('Mappable', 'use_compressed_assets');
-
-		$instance = $this->getInstance();
-		Config::inst()->update('Mappable', 'use_compressed_assets', false);
-		$this->assertFalse($instance->UseCompressedAssets());
-
-		$instance = $this->getInstance();
-		Config::inst()->update('Mappable', 'use_compressed_assets', true);
-		$this->assertTrue($instance->UseCompressedAssets());
-
-		Config::inst()->update('Mappable', 'use_compressed_assets', $original);
-	}
-
-
-	private function getInstance() {
-		$instance = new Member();
-		return $instance;
-	}
-
-	/*
+    public function testHasGeoWest() {
+        $instance = $this->getInstance();
+        $instance->Lon = -20;
+        $this->assertTrue($instance->HasGeo());
+    }
+
+    public function testHasGeoEast() {
+        $instance = $this->getInstance();
+        $instance->Lon = 20;
+        $this->assertTrue($instance->HasGeo());
+    }
+
+    public function testHasGeoNorth() {
+        $instance = $this->getInstance();
+        $instance->Lat = 20;
+        $this->assertTrue($instance->HasGeo());
+    }
+
+    public function testHasGeoNorthWest() {
+        $instance = $this->getInstance();
+        $instance->Lat = 20;
+        $instance->Lon = -20;
+        $this->assertTrue($instance->HasGeo());
+    }
+
+    public function testHasGeoNortEast() {
+        $instance = $this->getInstance();
+        $instance->Lat = 20;
+        $instance->Lon = 20;
+        $this->assertTrue($instance->HasGeo());
+    }
+
+    public function testHasGeoSouth() {
+        $instance = $this->getInstance();
+        $instance->Lat = -20;
+        $this->assertTrue($instance->HasGeo());
+    }
+
+    public function testHasGeoSouthWest() {
+        $instance = $this->getInstance();
+        $instance->Lat = -20;
+        $instance->Lon = -20;
+        $this->assertTrue($instance->HasGeo());
+    }
+
+    public function testHasGeoSouthEast() {
+        $instance = $this->getInstance();
+        $instance->Lat = -20;
+        $instance->Lon = 20;
+        $this->assertTrue($instance->HasGeo());
+    }
+
+    public function testHasGeoOrigin() {
+        $instance = $this->getInstance();
+        $instance->Lat = 0;
+        $instance->Lon = 0;
+        $this->assertFalse($instance->HasGeo());
+    }
+
+    public function testHasGeoOriginMapLayerExtension() {
+        $instance = $this->getInstance();
+
+        // assert that origin has no geo (until layers added)
+        $instance->Lat = 0;
+        $instance->Lon = 0;
+        $this->assertFalse($instance->HasGeo());
+
+        $this->addLayerToInstance($instance);
+
+        // assert has geo even when at the origin of 0,0
+        $this->assertTrue($instance->HasGeo());
+    }
+
+    public function testBasicMap() {
+        $instance = $this->getInstance();
+        $instance->Lat = 37.1;
+        $instance->Lon = 28;
+        $instance->Zoom = 12;
+        $instance->MapPinEdited = true;
+        $html = $instance->BasicMap()->forTemplate();
+
+        $expected = "data-centre='{\"lat\":37.1,\"lng\":28}'";
+        $this->assertContains($expected, $html);
+        $expected = "data-mapmarkers='[{\"latitude\":37.1,\"longitude\":28,\"html\":\"MEMBER: \",\"category\":\"default\",\"icon\":false}]'";
+        $this->assertContains($expected, $html);
+
+        // This is only set automatically with layers
+        $expected = 'data-enableautocentrezoom=false';
+        $this->assertContains($expected, $html);
+    }
+
+    public function testBasicMapWithLayer() {
+        $instance = $this->getInstance();
+        $instance->Lat = 37.1;
+        $instance->Lon = 28;
+        $instance->Zoom = 12;
+        $instance->MapPinEdited = true;
+        $instance->write();
+        $this->addLayerToInstance($instance);
+        $html = $instance->BasicMap()->forTemplate();
+
+        $expected = "data-centre='{\"lat\":37.1,\"lng\":28}'";
+        $this->assertContains($expected, $html);
+        $expected = "data-mapmarkers='[{\"latitude\":37.1,\"longitude\":28,\"html\":\"MEMBER: \",\"category\":\"default\",\"icon\":false}]'";
+        $this->assertContains($expected, $html);
+
+        // This is only set automatically with layers
+        $expected = 'data-enableautocentrezoom=1';
+        $this->assertContains($expected, $html);
+    }
+
+
+    public function testGetMapField() {
+        $instance = $this->getInstance();
+        $this->Lat = 37.1;
+        $this->Lon = 28;
+        $this->Zoom = 12;
+        $mapField  = $instance->getMapField();
+        $this->assertInstanceOf('LatLongField', $mapField);
+    }
+
+
+    public function testUseCompressedAssets() {
+        $original = Config::inst()->get('Mappable', 'use_compressed_assets');
+
+        $instance = $this->getInstance();
+        Config::inst()->update('Mappable', 'use_compressed_assets', false);
+        $this->assertFalse($instance->UseCompressedAssets());
+
+        $instance = $this->getInstance();
+        Config::inst()->update('Mappable', 'use_compressed_assets', true);
+        $this->assertTrue($instance->UseCompressedAssets());
+
+        Config::inst()->update('Mappable', 'use_compressed_assets', $original);
+    }
+
+
+    private function getInstance() {
+        $instance = new Member();
+        return $instance;
+    }
+
+    /*
 	Add a map layer to an existing instance
 	 */
-	private function addLayerToInstance(&$instance) {
-		// Create a layer
-		$kmlFile = new File(array('Name' => 'example.kml', 'Filename' => 'mappable/tests/kml/example.kml'));
-		$layer = new MapLayer();
-		$layer->Title = 'Example KML Layer';
-		$layer->KmlFile = $kmlFile;
-		$layer->write();
-
-		// add the layer to the Member object
-		$layers = $instance->MapLayers();
-		$layers->add($layer);
-	}
-
-	private function addMapPinToInstance(&$instance) {
-		// Create a pin
-		$copied = copy('mappable/tests/images/mapicontest.png', 'assets/mapicontest.png');
-		$this->assertTrue($copied);
-		$imageFile = new Image(array('Name' => 'mapicontest.png', 'Filename' => 'assets/mapicontest.png'));
-		$imageFile->write();
-		$instance->MapPinIconID = $imageFile->ID;
-		$instance->write();
-	}
-
-	/**
-	 * @param integer $lat
-	 * @param integer $lon
-	 */
-	private function showMapPinEdited(&$instance, $lat, $lon) {
-		$instance->Lat = $lat;
-		$instance->Long = $lon;
-		$instance->write();
-		$this->assertTrue($instance->MapPinEdited);
-	}
+    private function addLayerToInstance(&$instance) {
+        // Create a layer
+        $kmlFile = new File(array('Name' => 'example.kml', 'Filename' => 'mappable/tests/kml/example.kml'));
+        $layer = new MapLayer();
+        $layer->Title = 'Example KML Layer';
+        $layer->KmlFile = $kmlFile;
+        $layer->write();
+
+        // add the layer to the Member object
+        $layers = $instance->MapLayers();
+        $layers->add($layer);
+    }
+
+    private function addMapPinToInstance(&$instance) {
+        // Create a pin
+        $copied = copy('mappable/tests/images/mapicontest.png', 'assets/mapicontest.png');
+        $this->assertTrue($copied);
+        $imageFile = new Image(array('Name' => 'mapicontest.png', 'Filename' => 'assets/mapicontest.png'));
+        $imageFile->write();
+        $instance->MapPinIconID = $imageFile->ID;
+        $instance->write();
+    }
+
+    /**
+     * @param integer $lat
+     * @param integer $lon
+     */
+    private function showMapPinEdited(&$instance, $lat, $lon) {
+        $instance->Lat = $lat;
+        $instance->Long = $lon;
+        $instance->write();
+        $this->assertTrue($instance->MapPinEdited);
+    }
 
 
 

code/MapField.php

Spacing +5 added lines, -5 removed lines

@@ -19,19 +19,19 @@ 
 			// legacy handling for old parameters: $title, $heading, ...
 			// instead of new handling: $name, $title, $heading, ...
 			$args = func_get_args();
-			if(!isset($args[1]) || is_numeric($args[1])) {
+			if (!isset($args[1]) || is_numeric($args[1])) {
 					$title = (isset($args[0])) ? $args[0] : null;
 					// Use "HeaderField(title)" as the default field name for a HeaderField;
 					// if it's just set to title then we risk causing accidental duplicate-field creation.
 
 					// this means i18nized fields won't be easily accessible through fieldByName()
-					$name = 'MapField' . $title;
+					$name = 'MapField'.$title;
 					$headingLevel = (isset($args[1])) ? $args[1] : null;
 					$allowHTML = (isset($args[2])) ? $args[2] : null;
 					$form = (isset($args[3])) ? $args[3] : null;
 			}
 
-			if($headingLevel) $this->headingLevel = $headingLevel;
+			if ($headingLevel) $this->headingLevel = $headingLevel;
 			$this->allowHTML = $allowHTML;
 			parent::__construct($name, $title, null, $allowHTML, $form);
 		}
@@ -47,9 +47,9 @@ 
 
 				Requirements::css('mappable/css/mapField.css');
 
-				return '<div class="editableMap">' . $this->createTag(
+				return '<div class="editableMap">'.$this->createTag(
 						"div",
 						$attributes
-				) . '</div>';
+				).'</div>';
 		}
 }

Indentation +42 added lines, -42 removed lines

@@ -4,52 +4,52 @@
  */
 class MapField extends DatalessField {
 
-		/**
-		 * @var int $headingLevel The level of the <h1> to <h6> HTML tag. Default: 2
-		 */
-		protected $headingLevel = 2;
-		private $divId;
+        /**
+         * @var int $headingLevel The level of the <h1> to <h6> HTML tag. Default: 2
+         */
+        protected $headingLevel = 2;
+        private $divId;
 
-		/**
-		 * @param string $name
-		 * @param string $title
-		 */
-		function __construct($name, $title = null, $headingLevel = 2, $allowHTML = false, $form = null) {
-			$this->divId = $name;
-			// legacy handling for old parameters: $title, $heading, ...
-			// instead of new handling: $name, $title, $heading, ...
-			$args = func_get_args();
-			if(!isset($args[1]) || is_numeric($args[1])) {
-					$title = (isset($args[0])) ? $args[0] : null;
-					// Use "HeaderField(title)" as the default field name for a HeaderField;
-					// if it's just set to title then we risk causing accidental duplicate-field creation.
+        /**
+         * @param string $name
+         * @param string $title
+         */
+        function __construct($name, $title = null, $headingLevel = 2, $allowHTML = false, $form = null) {
+            $this->divId = $name;
+            // legacy handling for old parameters: $title, $heading, ...
+            // instead of new handling: $name, $title, $heading, ...
+            $args = func_get_args();
+            if(!isset($args[1]) || is_numeric($args[1])) {
+                    $title = (isset($args[0])) ? $args[0] : null;
+                    // Use "HeaderField(title)" as the default field name for a HeaderField;
+                    // if it's just set to title then we risk causing accidental duplicate-field creation.
 
-					// this means i18nized fields won't be easily accessible through fieldByName()
-					$name = 'MapField' . $title;
-					$headingLevel = (isset($args[1])) ? $args[1] : null;
-					$allowHTML = (isset($args[2])) ? $args[2] : null;
-					$form = (isset($args[3])) ? $args[3] : null;
-			}
+                    // this means i18nized fields won't be easily accessible through fieldByName()
+                    $name = 'MapField' . $title;
+                    $headingLevel = (isset($args[1])) ? $args[1] : null;
+                    $allowHTML = (isset($args[2])) ? $args[2] : null;
+                    $form = (isset($args[3])) ? $args[3] : null;
+            }
 
-			if($headingLevel) $this->headingLevel = $headingLevel;
-			$this->allowHTML = $allowHTML;
-			parent::__construct($name, $title, null, $allowHTML, $form);
-		}
+            if($headingLevel) $this->headingLevel = $headingLevel;
+            $this->allowHTML = $allowHTML;
+            parent::__construct($name, $title, null, $allowHTML, $form);
+        }
 
-		function Field($properties = array()) {
-				Requirements::javascript('framework/thirdparty/jquery/jquery.js');
-				Requirements::javascript('framework/thirdparty/jquery-livequery/jquery.livequery.js');
-				$attributes = array(
-						'class' => 'middleColumn',
-						'id' => $this->divId,
-						'style' => "width:100%;height:300px;margin:5px 0px 5px 5px;position:relative;"
-				);
+        function Field($properties = array()) {
+                Requirements::javascript('framework/thirdparty/jquery/jquery.js');
+                Requirements::javascript('framework/thirdparty/jquery-livequery/jquery.livequery.js');
+                $attributes = array(
+                        'class' => 'middleColumn',
+                        'id' => $this->divId,
+                        'style' => "width:100%;height:300px;margin:5px 0px 5px 5px;position:relative;"
+                );
 
-				Requirements::css('mappable/css/mapField.css');
+                Requirements::css('mappable/css/mapField.css');
 
-				return '<div class="editableMap">' . $this->createTag(
-						"div",
-						$attributes
-				) . '</div>';
-		}
+                return '<div class="editableMap">' . $this->createTag(
+                        "div",
+                        $attributes
+                ) . '</div>';
+        }
 }

Braces +3 added lines, -1 removed lines

@@ -31,7 +31,9 @@
 					$form = (isset($args[3])) ? $args[3] : null;
 			}
 
-			if($headingLevel) $this->headingLevel = $headingLevel;
+			if($headingLevel) {
+			    $this->headingLevel = $headingLevel;
+			}
 			$this->allowHTML = $allowHTML;
 			parent::__construct($name, $title, null, $allowHTML, $form);
 		}

code/Mappable.php

Indentation +47 added lines, -47 removed lines

@@ -9,58 +9,58 @@
  */
 interface Mappable {
 
-	/**
-	 * An accessor method for the latitude field.
-	 * @example
-	 * <code>
-	 * 	return $this->Lat;
-	 * </code>
-	 *
-	 * @return string
-	 */
-	public function getMappableLatitude();
+    /**
+     * An accessor method for the latitude field.
+     * @example
+     * <code>
+     * 	return $this->Lat;
+     * </code>
+     *
+     * @return string
+     */
+    public function getMappableLatitude();
 
 
-	/**
-	 * An accessor method for the longitude field.
-	 * @example
-	 * <code>
-	 * 	return $this->Long;
-	 * </code>
-	 *
-	 * @return string
-	 */
-	public function getMappableLongitude();
+    /**
+     * An accessor method for the longitude field.
+     * @example
+     * <code>
+     * 	return $this->Long;
+     * </code>
+     *
+     * @return string
+     */
+    public function getMappableLongitude();
 
 
-	/**
-	 * An accessor method for the path to the marker pin for this point on the map.
-	 * If null or false, use the default Google Maps icon.
-	 * @example
-	 * <code>
-	 * return "mysite/images/map_icon.png";
-	 * </code>
-	 *
-	 * @return string
-	 */
-	public function getMappableMapPin();
+    /**
+     * An accessor method for the path to the marker pin for this point on the map.
+     * If null or false, use the default Google Maps icon.
+     * @example
+     * <code>
+     * return "mysite/images/map_icon.png";
+     * </code>
+     *
+     * @return string
+     */
+    public function getMappableMapPin();
 
 
-	/**
-	 * An accessor method that returns the content for the map bubble popup.
-	 * It is best to use the {@see ViewableData::renderWith()} method to take advantaging
-	 * of templating syntax when rendering the object's content.
-	 *
-	 * Note: it is critical that the content be sanitized for safe inclusino in the rendered
-	 * JavaScript code for the map. {@see GoogleMapsUtil::sanitize()}
-	 *
-	 * @example
-	 * <code>
-	 * return GoogleMapsUtil::sanitize($this->renderWith('MapBubble'));
-	 * </code>
-	 *
-	 * @return string
-	 */
-	public function getMappableMapContent();
+    /**
+     * An accessor method that returns the content for the map bubble popup.
+     * It is best to use the {@see ViewableData::renderWith()} method to take advantaging
+     * of templating syntax when rendering the object's content.
+     *
+     * Note: it is critical that the content be sanitized for safe inclusino in the rendered
+     * JavaScript code for the map. {@see GoogleMapsUtil::sanitize()}
+     *
+     * @example
+     * <code>
+     * return GoogleMapsUtil::sanitize($this->renderWith('MapBubble'));
+     * </code>
+     *
+     * @return string
+     */
+    public function getMappableMapContent();
 
 }