ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f87
ilMapGUI Class Reference

User interface class for maps. More...

+ Inheritance diagram for ilMapGUI:
+ Collaboration diagram for ilMapGUI:

Public Member Functions

 __construct ()
 
 setMapId ($a_mapid)
 Set Map ID. More...
 
 getMapId ()
 Get Map ID. More...
 
 setWidth ($a_width)
 Set Width. More...
 
 getWidth ()
 Get Width. More...
 
 setHeight ($a_height)
 Set Height. More...
 
 getHeight ()
 Get Height. More...
 
 setLatitude ($a_latitude)
 Set Latitude. More...
 
 getLatitude ()
 Get Latitude. More...
 
 setLongitude ($a_longitude)
 Set Longitude. More...
 
 getLongitude ()
 Get Longitude. More...
 
 setZoom ($a_zoom)
 Set Zoom. More...
 
 getZoom ()
 Get Zoom. More...
 
 setEnableTypeControl ($a_enabletypecontrol)
 Set Use Map Type Control. More...
 
 getEnableTypeControl ()
 Get Use Map Type Control. More...
 
 setEnableNavigationControl ($a_enablenavigationcontrol)
 Set Use Navigation Control. More...
 
 getEnableNavigationControl ()
 Get Use Navigation Control. More...
 
 setEnableUpdateListener ($a_enableupdatelistener)
 Set Activate Update Listener. More...
 
 getEnableUpdateListener ()
 Get Activate Update Listener. More...
 
 setEnableLargeMapControl ($a_largemapcontrol)
 Set Large Map Control. More...
 
 getEnableLargeMapControl ()
 Get Large Map Control. More...
 
 setEnableCentralMarker ($a_centralmarker)
 Enable Central Marker. More...
 
 getEnableCentralMarker ()
 Get Enable Central Marker. More...
 
 addUserMarker ($a_user_id)
 Add user marker. More...
 
 getHtml ()
 Get HTML. More...
 
 getUserListHtml ()
 Get User List HTML (to be displayed besides the map) More...
 

Protected Attributes

 $mapid
 
 $width = "500px"
 
 $height = "300px"
 
 $latitude
 
 $longitude
 
 $zoom
 
 $enabletypecontrol = false
 
 $enableupdatelistener = false
 
 $enablenavigationcontrol = false
 
 $enablelargemapcontrol = false
 
 $user_marker = array()
 

Detailed Description

User interface class for maps.

Author
Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de
Version
$Id$

Definition at line 33 of file class.ilMapGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilMapGUI::__construct ( )

Definition at line 47 of file class.ilMapGUI.php.

References $lng, and $tpl.

48  {
49  global $lng, $tpl;
50 
51  $lng->loadLanguageModule("maps");
52  }
global $tpl
Definition: ilias.php:8
global $lng
Definition: privfeed.php:40

Member Function Documentation

◆ addUserMarker()

ilMapGUI::addUserMarker (   $a_user_id)

Add user marker.

Parameters
int$a_user_idUser ID

Definition at line 290 of file class.ilMapGUI.php.

References getHtml(), and getUserListHtml().

291  {
292  return $this->user_marker[] = $a_user_id;
293  }
+ Here is the call graph for this function:

◆ getEnableCentralMarker()

ilMapGUI::getEnableCentralMarker ( )

Get Enable Central Marker.

Returns
boolean Central Marker

Definition at line 280 of file class.ilMapGUI.php.

Referenced by ilOpenLayersMapGUI\getHtml(), and ilGoogleMapGUI\getHtml().

281  {
282  return $this->centralmarker;
283  }
+ Here is the caller graph for this function:

◆ getEnableLargeMapControl()

ilMapGUI::getEnableLargeMapControl ( )

Get Large Map Control.

Returns
boolean Large Map Control

Definition at line 259 of file class.ilMapGUI.php.

Referenced by ilGoogleMapGUI\getHtml().

260  {
261  return $this->largemapcontrol;
262  }
+ Here is the caller graph for this function:

◆ getEnableNavigationControl()

ilMapGUI::getEnableNavigationControl ( )

Get Use Navigation Control.

Returns
boolean Use Navigation Control

Definition at line 217 of file class.ilMapGUI.php.

References $enablenavigationcontrol.

Referenced by ilOpenLayersMapGUI\getHtml(), and ilGoogleMapGUI\getHtml().

218  {
220  }
$enablenavigationcontrol
+ Here is the caller graph for this function:

◆ getEnableTypeControl()

ilMapGUI::getEnableTypeControl ( )

Get Use Map Type Control.

Returns
boolean Use Map Type Control

Definition at line 196 of file class.ilMapGUI.php.

References $enabletypecontrol.

Referenced by ilGoogleMapGUI\getHtml().

197  {
199  }
+ Here is the caller graph for this function:

◆ getEnableUpdateListener()

ilMapGUI::getEnableUpdateListener ( )

Get Activate Update Listener.

Returns
boolean Activate Update Listener

Definition at line 238 of file class.ilMapGUI.php.

References $enableupdatelistener.

Referenced by ilOpenLayersMapGUI\getHtml(), and ilGoogleMapGUI\getHtml().

239  {
241  }
+ Here is the caller graph for this function:

◆ getHeight()

ilMapGUI::getHeight ( )

Get Height.

Returns
string Height

Definition at line 112 of file class.ilMapGUI.php.

References $height.

Referenced by ilOpenLayersMapGUI\getHtml(), and ilGoogleMapGUI\getHtml().

113  {
114  return $this->height;
115  }
+ Here is the caller graph for this function:

◆ getHtml()

ilMapGUI::getHtml ( )
abstract

Get HTML.

Referenced by addUserMarker().

+ Here is the caller graph for this function:

◆ getLatitude()

ilMapGUI::getLatitude ( )

Get Latitude.

Returns
string Latitude

Definition at line 133 of file class.ilMapGUI.php.

References $latitude.

Referenced by ilOpenLayersMapGUI\getHtml(), and ilGoogleMapGUI\getHtml().

134  {
135  return $this->latitude;
136  }
+ Here is the caller graph for this function:

◆ getLongitude()

ilMapGUI::getLongitude ( )

Get Longitude.

Returns
string Longitude

Definition at line 154 of file class.ilMapGUI.php.

References $longitude.

Referenced by ilOpenLayersMapGUI\getHtml(), and ilGoogleMapGUI\getHtml().

155  {
156  return $this->longitude;
157  }
+ Here is the caller graph for this function:

◆ getMapId()

ilMapGUI::getMapId ( )

Get Map ID.

Returns
string Map ID

Definition at line 70 of file class.ilMapGUI.php.

References $mapid.

Referenced by ilOpenLayersMapGUI\getHtml(), ilGoogleMapGUI\getHtml(), ilOpenLayersMapGUI\getUserListHtml(), and ilGoogleMapGUI\getUserListHtml().

71  {
72  return $this->mapid;
73  }
+ Here is the caller graph for this function:

◆ getUserListHtml()

ilMapGUI::getUserListHtml ( )
abstract

Get User List HTML (to be displayed besides the map)

Referenced by addUserMarker().

+ Here is the caller graph for this function:

◆ getWidth()

ilMapGUI::getWidth ( )

Get Width.

Returns
string Width

Definition at line 91 of file class.ilMapGUI.php.

References $width.

Referenced by ilOpenLayersMapGUI\getHtml(), and ilGoogleMapGUI\getHtml().

92  {
93  return $this->width;
94  }
+ Here is the caller graph for this function:

◆ getZoom()

ilMapGUI::getZoom ( )

Get Zoom.

Returns
int Zoom

Definition at line 175 of file class.ilMapGUI.php.

References $zoom.

Referenced by ilOpenLayersMapGUI\getHtml(), and ilGoogleMapGUI\getHtml().

176  {
177  return $this->zoom;
178  }
+ Here is the caller graph for this function:

◆ setEnableCentralMarker()

ilMapGUI::setEnableCentralMarker (   $a_centralmarker)

Enable Central Marker.

Parameters
boolean$a_centralmarkerCentral Marker

Definition at line 269 of file class.ilMapGUI.php.

270  {
271  $this->centralmarker = $a_centralmarker;
272  return $this;
273  }

◆ setEnableLargeMapControl()

ilMapGUI::setEnableLargeMapControl (   $a_largemapcontrol)

Set Large Map Control.

Parameters
boolean$a_largemapcontrolLarge Map Control

Definition at line 248 of file class.ilMapGUI.php.

249  {
250  $this->largemapcontrol = $a_largemapcontrol;
251  return $this;
252  }

◆ setEnableNavigationControl()

ilMapGUI::setEnableNavigationControl (   $a_enablenavigationcontrol)

Set Use Navigation Control.

Parameters
boolean$a_enablenavigationcontrolUse Navigation Control

Definition at line 206 of file class.ilMapGUI.php.

207  {
208  $this->enablenavigationcontrol = $a_enablenavigationcontrol;
209  return $this;
210  }

◆ setEnableTypeControl()

ilMapGUI::setEnableTypeControl (   $a_enabletypecontrol)

Set Use Map Type Control.

Parameters
boolean$a_enabletypecontrolUse Map Type Control

Definition at line 185 of file class.ilMapGUI.php.

186  {
187  $this->enabletypecontrol = $a_enabletypecontrol;
188  return $this;
189  }

◆ setEnableUpdateListener()

ilMapGUI::setEnableUpdateListener (   $a_enableupdatelistener)

Set Activate Update Listener.

Parameters
boolean$a_enableupdatelistenerActivate Update Listener

Definition at line 227 of file class.ilMapGUI.php.

228  {
229  $this->enableupdatelistener = $a_enableupdatelistener;
230  return $this;
231  }

◆ setHeight()

ilMapGUI::setHeight (   $a_height)

Set Height.

Parameters
string$a_heightHeight

Definition at line 101 of file class.ilMapGUI.php.

102  {
103  $this->height = $a_height;
104  return $this;
105  }

◆ setLatitude()

ilMapGUI::setLatitude (   $a_latitude)

Set Latitude.

Parameters
string$a_latitudeLatitude

Definition at line 122 of file class.ilMapGUI.php.

123  {
124  $this->latitude = $a_latitude;
125  return $this;
126  }

◆ setLongitude()

ilMapGUI::setLongitude (   $a_longitude)

Set Longitude.

Parameters
string$a_longitudeLongitude

Definition at line 143 of file class.ilMapGUI.php.

144  {
145  $this->longitude = $a_longitude;
146  return $this;
147  }

◆ setMapId()

ilMapGUI::setMapId (   $a_mapid)

Set Map ID.

Parameters
string$a_mapidMap ID

Definition at line 59 of file class.ilMapGUI.php.

60  {
61  $this->mapid = $a_mapid;
62  return $this;
63  }

◆ setWidth()

ilMapGUI::setWidth (   $a_width)

Set Width.

Parameters
string$a_widthWidth

Definition at line 80 of file class.ilMapGUI.php.

81  {
82  $this->width = $a_width;
83  return $this;
84  }

◆ setZoom()

ilMapGUI::setZoom (   $a_zoom)

Set Zoom.

Parameters
int$a_zoomZoom

Definition at line 164 of file class.ilMapGUI.php.

165  {
166  $this->zoom = $a_zoom;
167  return $this;
168  }

Field Documentation

◆ $enablelargemapcontrol

ilMapGUI::$enablelargemapcontrol = false
protected

Definition at line 44 of file class.ilMapGUI.php.

◆ $enablenavigationcontrol

ilMapGUI::$enablenavigationcontrol = false
protected

Definition at line 43 of file class.ilMapGUI.php.

Referenced by getEnableNavigationControl().

◆ $enabletypecontrol

ilMapGUI::$enabletypecontrol = false
protected

Definition at line 41 of file class.ilMapGUI.php.

Referenced by getEnableTypeControl().

◆ $enableupdatelistener

ilMapGUI::$enableupdatelistener = false
protected

Definition at line 42 of file class.ilMapGUI.php.

Referenced by getEnableUpdateListener().

◆ $height

ilMapGUI::$height = "300px"
protected

Definition at line 37 of file class.ilMapGUI.php.

Referenced by getHeight().

◆ $latitude

ilMapGUI::$latitude
protected

Definition at line 38 of file class.ilMapGUI.php.

Referenced by getLatitude().

◆ $longitude

ilMapGUI::$longitude
protected

Definition at line 39 of file class.ilMapGUI.php.

Referenced by getLongitude().

◆ $mapid

ilMapGUI::$mapid
protected

Definition at line 35 of file class.ilMapGUI.php.

Referenced by getMapId().

◆ $user_marker

ilMapGUI::$user_marker = array()
protected

Definition at line 45 of file class.ilMapGUI.php.

◆ $width

ilMapGUI::$width = "500px"
protected

Definition at line 36 of file class.ilMapGUI.php.

Referenced by getWidth().

◆ $zoom

ilMapGUI::$zoom
protected

Definition at line 40 of file class.ilMapGUI.php.

Referenced by getZoom().


The documentation for this class was generated from the following file: