gordonbanderson / Mappable

code/MapAPI.php

Doc Comments +28 added lines, -27 removed lines

@@ -212,7 +212,7 @@ 
 	 *
 	 * @param string  $googleMapKey the googleMapKey
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setKey($googleMapKey) {
@@ -220,6 +220,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param boolean $inclusion
+	 */
 	public function setIncludeDownloadJavascript($inclusion) {
 		self::$include_download_javascript = $inclusion;
 		return $this;
@@ -253,13 +256,9 @@ 
 	 * Set the useClusterer parameter (optimization to display a lot of marker)
 	 *
 	 * @param boolean $useClusterer           use cluster or not
-	 * @param string  $clusterIcon            the cluster icon
-	 * @param int     $maxVisibleMarkers      max visible markers
 	 * @param int     $gridSize               grid size
-	 * @param int     $minMarkersPerClusterer minMarkersPerClusterer
-	 * @param int     $maxLinesPerInfoBox     maxLinesPerInfoBox
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setClusterer($useClusterer, $gridSize=50, $maxZoom=17,
@@ -276,7 +275,7 @@ 
 	 *
 	 * @param string  $googleMapId the google div ID
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setDivId($googleMapId) {
@@ -289,7 +288,7 @@ 
 	 *
 	 * @param string  $googleMapDirectionId GoogleMap  Direction ID for the HTML DIV
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setDirectionDivId($googleMapDirectionId) {
@@ -304,7 +303,7 @@ 
 	 * @param int     $width  GoogleMap  width
 	 * @param int     $height GoogleMap  height
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setSize($width, $height) {
@@ -320,7 +319,7 @@ 
 	 * @param int     $iconWidth  GoogleMap  marker icon width
 	 * @param int     $iconHeight GoogleMap  marker icon height
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setIconSize($iconWidth, $iconHeight) {
@@ -334,7 +333,7 @@ 
 	 *
 	 * @param string  $lang GoogleMap  lang : fr,en,..
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setLang($lang) {
@@ -347,7 +346,7 @@ 
 	 *
 	 * @param int     $zoom GoogleMap  zoom.
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setZoom($zoom) {
@@ -358,9 +357,8 @@ 
 	/**
 	 * Set the zoom of the infowindow
 	 *
-	 * @param int     $zoom GoogleMap  zoom.
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setInfoWindowZoom($infoWindowZoom) {
@@ -371,9 +369,8 @@ 
 	/**
 	 * Enable the zoom on the marker when you click on it
 	 *
-	 * @param int     $zoom GoogleMap  zoom.
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setEnableWindowZoom($enableWindowZoom) {
@@ -384,9 +381,9 @@ 
 	/**
 	 * Enable theautomatic center/zoom at the gmap load
 	 *
-	 * @param int     $zoom GoogleMap  zoom.
 	 *
-	 * @return void
+	 * @param boolean $enableAutomaticCenterZoom
+	 * @return MapAPI
 	 */
 
 	public function setEnableAutomaticCenterZoom($enableAutomaticCenterZoom) {
@@ -399,7 +396,7 @@ 
 	 *
 	 * @param string  $center GoogleMap  center (an address)
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setCenter($center) {
@@ -412,7 +409,7 @@ 
 	 *
 	 * @param string  $mapType  Can be one of road,satellite,hybrid or terrain. Defaults to road
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setMapType($mapType) {
@@ -458,7 +455,7 @@ 
 	 *
 	 * @param boolean $displayDirectionFields display directions or not in the info window
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setDisplayDirectionFields($displayDirectionFields) {
@@ -471,7 +468,7 @@ 
 	 *
 	 * @param boolean $defaultHideMarker hide all the markers on the map by default
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setDefaultHideMarker($defaultHideMarker) {
@@ -555,7 +552,7 @@ 
 	 * @param string  $category marker category
 	 * @param string  $icon     an icon url
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function addMarkerByCoords($lat, $lng, $html='', $category='', $icon='') {
@@ -579,7 +576,7 @@ 
 	 * @param string  $category marker category
 	 * @param string  $icon     an icon url
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function addMarkerByAddress($address, $content='', $category='', $icon='') {
@@ -599,7 +596,7 @@ 
 	 * @param string  $category marker category
 	 * @param string  $icon     an icon url
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function addArrayMarkerByCoords($coordtab, $category='', $icon='') {
@@ -681,7 +678,7 @@ 
 	 * @param string  $category marker category
 	 * @param string  $icon     an icon url
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function addArrayMarkerByAddress($coordtab, $category='', $icon='') {
@@ -710,7 +707,7 @@ 
 	 *
 	 * @param string  $url      url of the kml file compatible with gmap and gearth
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function addKML($url) {
@@ -870,6 +867,10 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $templateName
+	 * @param ArrayData $templateVariables
+	 */
 	function processTemplateHTML($templateName, $templateVariables = null ) {
 		if (!$templateVariables) {
 			$templateVariables = new ArrayList();

Indentation +2 added lines, -2 removed lines

@@ -446,8 +446,8 @@
 	}
 
 	/**
-	* Set the center of the gmap
-	**/
+	 * Set the center of the gmap
+	 **/
 	public function setLatLongCenter($center) {
 		$this->latLongCenter = $center;
 		return $this;

Spacing +15 added lines, -15 removed lines

@@ -203,7 +203,7 @@ 
 	 * @return void
 	 */
 
-	public function __construct($googleMapKey='') {
+	public function __construct($googleMapKey = '') {
 		$this->googleMapKey = $googleMapKey;
 	}
 
@@ -262,8 +262,8 @@ 
 	 * @return void
 	 */
 
-	public function setClusterer($useClusterer, $gridSize=50, $maxZoom=17,
-			$clustererLibraryPath='/mappable/javascript/google/markerclusterer.js') {
+	public function setClusterer($useClusterer, $gridSize = 50, $maxZoom = 17,
+			$clustererLibraryPath = '/mappable/javascript/google/markerclusterer.js') {
 		$this->useClusterer = $useClusterer;
 		$this->gridSize = $gridSize;
 		$this->maxZoom = $maxZoom;
@@ -558,7 +558,7 @@ 
 	 * @return void
 	 */
 
-	public function addMarkerByCoords($lat, $lng, $html='', $category='', $icon='') {
+	public function addMarkerByCoords($lat, $lng, $html = '', $category = '', $icon = '') {
 		$m = array(
 			'latitude' => $lat,
 			'longitude' => $lng,
@@ -582,9 +582,9 @@ 
 	 * @return void
 	 */
 
-	public function addMarkerByAddress($address, $content='', $category='', $icon='') {
+	public function addMarkerByAddress($address, $content = '', $category = '', $icon = '') {
 		$point = $this->geocoding($address);
-		if ($point!==null) {
+		if ($point !== null) {
 			$this->addMarkerByCoords($point[2], $point[3], $content, $category, $icon);
 		} else {
 			// throw new Exception('Adress not found : '.$address);
@@ -602,7 +602,7 @@ 
 	 * @return void
 	 */
 
-	public function addArrayMarkerByCoords($coordtab, $category='', $icon='') {
+	public function addArrayMarkerByCoords($coordtab, $category = '', $icon = '') {
 		foreach ($coordtab as $coord) {
 			$this->addMarkerByCoords($coord[0], $coord[1], $coord[2], $category, $icon);
 		}
@@ -684,7 +684,7 @@ 
 	 * @return void
 	 */
 
-	public function addArrayMarkerByAddress($coordtab, $category='', $icon='') {
+	public function addArrayMarkerByAddress($coordtab, $category = '', $icon = '') {
 		foreach ($coordtab as $coord) {
 			$this->addMarkerByAddress($coord[0], $coord[1], $category, $icon);
 		}
@@ -701,7 +701,7 @@ 
 	 * @return void
 	 */
 
-	public function addDirection($from, $to, $idpanel='') {
+	public function addDirection($from, $to, $idpanel = '') {
 		$this->contentMarker .= 'addDirection("'.$from.'","'.$to.'","'.$idpanel.'");';
 	}
 
@@ -765,9 +765,9 @@ 
 			$linesJson = stripslashes($this->jsonRemoveUnicodeSequences($this->lines));
 			$kmlJson = stripslashes($this->jsonRemoveUnicodeSequences($this->kmlFiles));
 		} else {
-			$jsonMarkers = stripslashes(json_encode($this->markers,JSON_UNESCAPED_UNICODE));
-			$linesJson = stripslashes(json_encode($this->lines,JSON_UNESCAPED_UNICODE));
-			$kmlJson = stripslashes(json_encode($this->kmlFiles,JSON_UNESCAPED_UNICODE));
+			$jsonMarkers = stripslashes(json_encode($this->markers, JSON_UNESCAPED_UNICODE));
+			$linesJson = stripslashes(json_encode($this->lines, JSON_UNESCAPED_UNICODE));
+			$kmlJson = stripslashes(json_encode($this->kmlFiles, JSON_UNESCAPED_UNICODE));
 		}
 
 
@@ -777,8 +777,8 @@ 
 							$this->latLongCenter : $this->geocoding($this->center);
 
 		// coordinates for centre depending on which method used
-		if ($geocodeCentre[0]=="200") { // success
-			$latlngCentre = array('lat'=>$geocodeCentre[2],'lng' => $geocodeCentre[3]);
+		if ($geocodeCentre[0] == "200") { // success
+			$latlngCentre = array('lat'=>$geocodeCentre[2], 'lng' => $geocodeCentre[3]);
 		} else { // Paris
 			$latlngCentre = array('lat'=>48.8792, 'lng' => 2.34778);
 		}
@@ -870,7 +870,7 @@ 
 		return $result;
 	}
 
-	function processTemplateHTML($templateName, $templateVariables = null ) {
+	function processTemplateHTML($templateName, $templateVariables = null) {
 		if (!$templateVariables) {
 			$templateVariables = new ArrayList();
 		}

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 +3 added lines, -3 removed lines

@@ -18,7 +18,7 @@ 
 		'MapPinIcon' => 'Image'
 	);
 
-	static $defaults = array (
+	static $defaults = array(
 		'Lat' =>0,
 		'Lon' => 0,
 		'Zoom' => 4,
@@ -145,7 +145,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;
@@ -155,7 +155,7 @@ 
 
 		// add points of interest taking into account the default icon of the layer as an override
 		if (Object::has_extension($this->owner->ClassName, 'PointsOfInterestLayerExtension')) {
-			foreach($this->owner->PointsOfInterestLayers() as $layer) {
+			foreach ($this->owner->PointsOfInterestLayers() as $layer) {
 				$layericon = $layer->DefaultIcon();
 				if ($layericon->ID === 0) {
 					$layericon = null;

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 '';
 		}
 

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 '';
 		}
 

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

code/MapField.php

Spacing +5 added lines, -5 removed lines

@@ -15,19 +15,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);
 		}
@@ -52,9 +52,9 @@ 
 
 				Requirements::css('mappable/css/mapField.css');
 
-				return '<div class="editableMap">' . $this->createTag(
+				return '<div class="editableMap">'.$this->createTag(
 						"div",
 						$attributes
-				) . '</div>';
+				).'</div>';
 		}
 }

Braces +3 added lines, -1 removed lines

@@ -27,7 +27,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);
 		}

Doc Comments +4 added lines

@@ -10,6 +10,10 @@
 		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, ...

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.'" />';
 	}
 

code/LatLongField.php

Doc Comments +3 added lines

@@ -19,6 +19,9 @@
 
 	private static $ctr = 0;
 
+	/**
+	 * @param string[] $buttonText
+	 */
 	public function __construct($children = array(), $buttonText = null) {
 		self::$ctr++;
 

Indentation +20 added lines, -20 removed lines

@@ -59,38 +59,38 @@
 		Requirements::javascript(MAPPABLE_MODULE_PATH.'/javascript/mapField.js');
 
 		$attributes = array(
-            'class' => 'editableMap',
-            'id' => 'GoogleMap',
-            'data-LatFieldName' => $this->latField,
+			'class' => 'editableMap',
+			'id' => 'GoogleMap',
+			'data-LatFieldName' => $this->latField,
 			'data-LonFieldName' => $this->longField,
 			'data-ZoomFieldName' => $this->zoomField,
 			'data-UseMapBounds' => false
-       );
+	   );
 
-        Requirements::css('mappable/css/mapField.css');
-        $guidePointsJSON = '';
-        if (!empty($this->guidePoints)) {
-        	$latlongps = array();
+		Requirements::css('mappable/css/mapField.css');
+		$guidePointsJSON = '';
+		if (!empty($this->guidePoints)) {
+			$latlongps = array();
 
 			foreach ($this->guidePoints as $guidepoint) {
 				array_push($latlongps, $guidepoint);
 			}
 
-        	$guidePointsJSON = json_encode($latlongps);
-        	// convert the mappable guidepoints to lat lon
+			$guidePointsJSON = json_encode($latlongps);
+			// convert the mappable guidepoints to lat lon
 
-        	$attributes['data-GuidePoints'] = $guidePointsJSON;
+			$attributes['data-GuidePoints'] = $guidePointsJSON;
 
-        	// we only wish to change the bounds to those of all the points iff
-        	// the item currently has no location
-        	$attributes['data-useMapBounds'] = true;
-        }
-        $content = '<div class="editableMapWrapper">' . $this->createTag(
-            "div",
-            $attributes
-       ) . '</div>';
+			// we only wish to change the bounds to those of all the points iff
+			// the item currently has no location
+			$attributes['data-useMapBounds'] = true;
+		}
+		$content = '<div class="editableMapWrapper">' . $this->createTag(
+			"div",
+			$attributes
+	   ) . '</div>';
 
-        $this->FieldList()->push(new LiteralField('locationEditor', $content));
+		$this->FieldList()->push(new LiteralField('locationEditor', $content));
 
 		$content2 = <<<HTML
 <div id="mapSearch">

Spacing +3 added lines, -3 removed lines

@@ -2,7 +2,7 @@ 
 
 class LatLongField extends FieldGroup {
 
-	private static $allowed_actions = array (
+	private static $allowed_actions = array(
 		'geocode'
 	);
 
@@ -85,10 +85,10 @@ 
         	// the item currently has no location
         	$attributes['data-useMapBounds'] = true;
         }
-        $content = '<div class="editableMapWrapper">' . $this->createTag(
+        $content = '<div class="editableMapWrapper">'.$this->createTag(
             "div",
             $attributes
-       ) . '</div>';
+       ).'</div>';
 
         $this->FieldList()->push(new LiteralField('locationEditor', $content));
 

code/MapUtil.php

Doc Comments +4 added lines, -1 removed lines

@@ -79,6 +79,9 @@ 
 	}
 
 
+	/**
+	 * @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;
 	}
@@ -155,7 +158,7 @@ 
 	/**
 	 * Get a new GoogleMapAPI object and load it with the default settings
 	 *
-	 * @return GoogleMapAPI
+	 * @return MapAPI
 	 */
 	public static function instance()
 	{

Spacing +5 added lines, -5 removed lines

@@ -146,7 +146,7 @@ 
 	 * @return void
 	 */
 
-	public function set_icon_size($iconWidth,$iconHeight)
+	public function set_icon_size($iconWidth, $iconHeight)
 	{
 		self::$iconWidth = $iconWidth;
 		self::$iconHeight = $iconHeight;
@@ -208,7 +208,7 @@ 
 	 * @return string
 	 */
 	public static function sanitize($content) {
-		return addslashes(str_replace(array("\n","\r", "\t"), '' ,$content));
+		return addslashes(str_replace(array("\n", "\r", "\t"), '', $content));
 	}
 
 
@@ -223,7 +223,7 @@ 
 	 */
 	public static function get_map(SS_List $list, $infowindowtemplateparams) {
 		$gmap = self::instance();
-		if($list) {
+		if ($list) {
 			foreach ($list as $mappable) {
 				if (self::ChooseToAddDataobject($mappable)) {
 					$gmap->addMarkerAsObject($mappable, $infowindowtemplateparams);
@@ -244,7 +244,7 @@ 
 	private static function ChooseToAddDataobject(DataObject $do) {
 		$isMappable = $do->is_a('Mappable');
 
-		foreach($do->getExtensionInstances() as $extension) {
+		foreach ($do->getExtensionInstances() as $extension) {
 			$isMappable = $isMappable || $extension instanceof Mappable;
 		}
 
@@ -252,6 +252,6 @@ 
 			? $do->MapPinEdited
 			: true;
 
-		return $isMappable && $filterMapPinEdited  ;
+		return $isMappable && $filterMapPinEdited;
 	}
 }