mapmanager/mapmanager.php File Reference

---

Detailed Description

The definition of the MapManager class.

As well as defining the MapManager class this file defines some related constants and utility functions.

Definition in file mapmanager.php.

Go to the source code of this file.

Classes
class	MapManager
	An encapsulation of common mapping functionality. More...
Enumerations
enum	MM_CLICK_MAIN
	The click point refers to the main map. More...
enum	MM_CLICK_REF
	The click point refers to the reference map. More...
enum	MM_ZOOM_NONE
	The zoom action is not set. More...
enum	MM_ZOOM_IN
	The zoom action is to increase zoom. More...
enum	MM_ZOOM_OUT
	The zoom action is to decrease zoom. More...
enum	MM_ZOOM_PAN
	The zoom action is to recenter. More...
enum	MM_ZOOM_SCALE
	The zoom action is to zoom to a specific scale. More...
enum	MM_ZOOM_EXTENT
	The zoom action is to zoom to a specific extent. More...
Functions
	imagePointToMapPoint ($image_point, $map_extent, $image_width, $image_height)
	Convert a point object in image coordinates to geographic coordinates.
	mapPointToImagePoint ($map_point, $map_extent, $image_width, $image_height)
	Converts a point object in geographic coordinates to pixel coordinates.
	rectToString ($rect)
	Obtain a string representation of a rectangle.
	stringToRect ($string)
	Convert a string representation of a rectangle to a rectObj.
	pointToString ($point)
	Obtain a string representation of a point.
	stringToPoint ($string)
	Convert a string representation of a point to a pointObj.

---

Enumeration Type Documentation

enum MM_CLICK_MAIN

The click point refers to the main map. Definition at line 185 of file mapmanager.php.

enum MM_CLICK_REF

The click point refers to the reference map. Definition at line 187 of file mapmanager.php.

enum MM_ZOOM_EXTENT

The zoom action is to zoom to a specific extent. Definition at line 201 of file mapmanager.php. Referenced by MapManager::zoom().

enum MM_ZOOM_IN

The zoom action is to increase zoom. Definition at line 193 of file mapmanager.php. Referenced by MapManager::zoom().

enum MM_ZOOM_NONE

The zoom action is not set. Definition at line 191 of file mapmanager.php. Referenced by MapManager::zoom().

enum MM_ZOOM_OUT

The zoom action is to decrease zoom. Definition at line 195 of file mapmanager.php. Referenced by MapManager::zoom().

enum MM_ZOOM_PAN

The zoom action is to recenter. Definition at line 197 of file mapmanager.php. Referenced by MapManager::MapManager(), and MapManager::zoom().

enum MM_ZOOM_SCALE

The zoom action is to zoom to a specific scale. Definition at line 199 of file mapmanager.php. Referenced by MapManager::zoom().

---

Function Documentation

imagePointToMapPoint (  $  image_point, $  map_extent, $  image_width, $  image_height )

Convert a point object in image coordinates to geographic coordinates. Parameters: $image_point  a pointObj in image coordinates $map_extent  a rectObj specifying the map extent $image_width  an integer specifying the image width in pixels $image_height  an integer specifying the image height in pixels Returns: a pointObj in geographic coordinates Definition at line 211 of file mapmanager.php.

mapPointToImagePoint (  $  map_point, $  map_extent, $  image_width, $  image_height )

Converts a point object in geographic coordinates to pixel coordinates. Parameters: $map_point  a pointObj in geographic coordinates $map_extent  a rectObj specifying the map extent $image_width  an integer specifying the image width in pixels $image_height  an integer specifying the image height in pixels Returns: a pointObj in map coordinates Definition at line 244 of file mapmanager.php.

pointToString (  $  point  )

Obtain a string representation of a point. This is suitable for representing a point in form values etc. Parameters: $point  a pointObj Returns: the serialised pointObj Definition at line 302 of file mapmanager.php.

rectToString (  $  rect  )

Obtain a string representation of a rectangle. This is suitable for representing a rectangle in form values etc. Parameters: $rect  a rectObj Returns: the serialised rectObj Definition at line 275 of file mapmanager.php. Referenced by MapManager::__sleep().

stringToPoint (  $  string  )

Convert a string representation of a point to a pointObj. Reverses pointToString(), converting a serialised pointObj back into a valid resource. Parameters: $string  a serialised pointObj Returns: the pointObj Definition at line 314 of file mapmanager.php.

stringToRect (  $  string  )

Convert a string representation of a rectangle to a rectObj. Reverses rectToString(), converting a serialised rectObj back into a valid resource. Parameters: $string  serialised rectObj Returns: a rectObj Definition at line 287 of file mapmanager.php. Referenced by MapManager::__wakeup().

---