gordonbanderson / Mappable

code/MapUtil.php

Doc Comments +5 added lines, -2 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;
 	}
@@ -156,7 +159,7 @@ 
 	/**
 	 * Get a new GoogleMapAPI object and load it with the default settings
 	 *
-	 * @return GoogleMapAPI
+	 * @return MapAPI
 	 */
 	public static function instance()
 	{
@@ -219,7 +222,7 @@ 
 	 * 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
+	 * @param  array $optionalinfowindowtemplatevalues Optional array of extra parameters to pass to the map info window
 	 * @return MapAPI
 	 */
 	public static function get_map(SS_List $list, $optionalinfowindowtemplatevalues) {

Indentation +62 added lines, -62 removed lines

@@ -23,11 +23,11 @@ 
 	 */
 	public static $map_height = '400px';
 
-    /** @var int Icon width of the gmarker **/
-    public static $iconWidth = 24;
+	/** @var int Icon width of the gmarker **/
+	public static $iconWidth = 24;
 
-    /** @var int Icon height of the gmarker **/
-    public static $iconHeight = 24;
+	/** @var int Icon height of the gmarker **/
+	public static $iconHeight = 24;
 
 	/**
 	 * @var int Prefix for the div ID of the map
@@ -99,59 +99,59 @@ 
 		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;
-    }
-
-    /**
-     * FIXME - NOT USED?
-      * Set the with of the gmap infowindow (on marker clik)
-      *
-      * @param int $info_window_width GoogleMap info window width
-      *
-      * @return void
-      */
-    public static function set_info_window_width($info_window_width)
-    {
-        self::$info_window_width = $info_window_width;
-    }
-
-    /**
-     * FIXME - NOT USED?
-      * Set the center of the gmap (an address)
-      *
-      * @param string $center GoogleMap  center (an address)
-      *
-      * @return void
-      */
-    public static function set_center($center)
-    {
-        self::$center = $center;
-    }
-
-    /**
-      * Set the size of the icon markers
-      *
-      * @param int $iconWidth GoogleMap  marker icon width
-      * @param int $iconHeight GoogleMap  marker icon height
-      *
-      * @return void
-      */
-
-    public function set_icon_size($iconWidth,$iconHeight)
-    {
-        self::$iconWidth = $iconWidth;
-        self::$iconHeight = $iconHeight;
-    }
+	/**
+	 * 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;
+	}
+
+	/**
+	 * FIXME - NOT USED?
+	 * Set the with of the gmap infowindow (on marker clik)
+	 *
+	 * @param int $info_window_width GoogleMap info window width
+	 *
+	 * @return void
+	 */
+	public static function set_info_window_width($info_window_width)
+	{
+		self::$info_window_width = $info_window_width;
+	}
+
+	/**
+	 * FIXME - NOT USED?
+	 * Set the center of the gmap (an address)
+	 *
+	 * @param string $center GoogleMap  center (an address)
+	 *
+	 * @return void
+	 */
+	public static function set_center($center)
+	{
+		self::$center = $center;
+	}
+
+	/**
+	 * Set the size of the icon markers
+	 *
+	 * @param int $iconWidth GoogleMap  marker icon width
+	 * @param int $iconHeight GoogleMap  marker icon height
+	 *
+	 * @return void
+	 */
+
+	public function set_icon_size($iconWidth,$iconHeight)
+	{
+		self::$iconWidth = $iconWidth;
+		self::$iconHeight = $iconHeight;
+	}
 
 	/**
 	 * Get a new GoogleMapAPI object and load it with the default settings
@@ -193,11 +193,11 @@ 
 		$gmap->setDisplayDirectionFields(self::$direction_fields);
 		$gmap->setSize(self::$map_width, self::$map_height);
 		$gmap->setDefaultHideMarker(self::$hide_marker);
-        $gmap->setMapType(self::$map_type);
-        $gmap->setCenter(self::$center);
-        $gmap->setIconSize(self::$iconWidth, self::$iconHeight);
-        $gmap->setIncludeDownloadJavascript(self::$map_already_rendered);
-        $gmap->setAllowFullScreen(self::$allow_full_screen);
+		$gmap->setMapType(self::$map_type);
+		$gmap->setCenter(self::$center);
+		$gmap->setIconSize(self::$iconWidth, self::$iconHeight);
+		$gmap->setIncludeDownloadJavascript(self::$map_already_rendered);
+		$gmap->setAllowFullScreen(self::$allow_full_screen);
 		return $gmap;
 	}
 

tests/MapExtensionTest.php

Doc Comments +4 added lines

@@ -193,6 +193,10 @@
 		return $instance;
 	}
 
+	/**
+	 * @param integer $lat
+	 * @param integer $lon
+	 */
 	private function showMapPinEdited(&$instance, $lat, $lon) {
 		$instance->Lat = $lat;
 		$instance->Long = $lon;

tests/MapUtilTest.php

Indentation +11 added lines, -11 removed lines

@@ -24,7 +24,7 @@ 
 	}
 
 	public function test_set_map_size() {
-    	MapUtil::set_map_size('890px','24em');
+		MapUtil::set_map_size('890px','24em');
 		$html = $this->htmlForMap();
 		$this->assertContains(' style="width:890px; height: 24em;"', $html);
 	}
@@ -79,25 +79,25 @@ 
 
 	// These appear to test code that's not used
 	public function test_set_center() {
-    	MapUtil::set_center('Bangkok, Thailand');
+		MapUtil::set_center('Bangkok, Thailand');
 		$html = $this->htmlForMap();
 		echo $html;
 		$this->fail('No evidence of map type changing');
-    }
+	}
 
-     public function test_set_map_type() {
-    	MapUtil::set_map_type('google.maps.MapTypeId.G_PHYSICAL_MAP');
+	 public function test_set_map_type() {
+		MapUtil::set_map_type('google.maps.MapTypeId.G_PHYSICAL_MAP');
 		$html = $this->htmlForMap();
 		echo $html;
 		$this->fail('No evidence of map type changing');
-    }
+	}
 
-     public function test_set_info_window_width()  {
-     	$this->fail('No evidence of set info width being used');
-    }
+	 public function test_set_info_window_width()  {
+	 	$this->fail('No evidence of set info width being used');
+	}
 
-     public function test_set_icon_size() {
+	 public function test_set_icon_size() {
 
-    }
+	}
 
 }

Spacing +3 added lines, -3 removed lines

@@ -24,7 +24,7 @@ 
 	}
 
 	public function test_set_map_size() {
-    	MapUtil::set_map_size('890px','24em');
+    	MapUtil::set_map_size('890px', '24em');
 		$html = $this->htmlForMap();
 		$this->assertContains(' style="width:890px; height: 24em;"', $html);
 	}
@@ -71,7 +71,7 @@ 
 	}
 
 	private function htmlForMap() {
-		$map = MapUtil::get_map(new ArrayList(),array());
+		$map = MapUtil::get_map(new ArrayList(), array());
 		$html = $map->forTemplate();
 		return $html;
 	}
@@ -92,7 +92,7 @@ 
 		$this->fail('No evidence of map type changing');
     }
 
-     public function test_set_info_window_width()  {
+     public function test_set_info_window_width() {
      	$this->fail('No evidence of set info width being used');
     }