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 ( )

Reimplemented in ilGoogleMapGUI, and ilOpenLayersMapGUI.

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

        {
                global $DIC;
                $lng = $DIC['lng'];
                $tpl = $DIC['tpl'];
                        
                $lng->loadLanguageModule("maps");
        }

References $DIC, $lng, and $tpl.

Member Function Documentation

◆ addUserMarker()

ilMapGUI::addUserMarker ( $a_user_id )

Add user marker.

Parameters

int $a_user_id User ID

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

        {
                return $this->user_marker[] = $a_user_id;
        }

◆ getEnableCentralMarker()

ilMapGUI::getEnableCentralMarker ( )

Get Enable Central Marker.

Returns: boolean Central Marker

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

        {
                return $this->centralmarker;
        }

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

Here is the caller graph for this function:

◆ getEnableLargeMapControl()

ilMapGUI::getEnableLargeMapControl ( )

Get Large Map Control.

Returns: boolean Large Map Control

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

        {
                return $this->largemapcontrol;
        }

Referenced by ilGoogleMapGUI\getHtml().

Here is the caller graph for this function:

◆ getEnableNavigationControl()

ilMapGUI::getEnableNavigationControl ( )

Get Use Navigation Control.

Returns: boolean Use Navigation Control

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

        {
                return $this->enablenavigationcontrol;
        }

References $enablenavigationcontrol.

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

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 198 of file class.ilMapGUI.php.

        {
                return $this->enabletypecontrol;
        }

References $enabletypecontrol.

Referenced by ilGoogleMapGUI\getHtml().

Here is the caller graph for this function:

◆ getEnableUpdateListener()

ilMapGUI::getEnableUpdateListener ( )

Get Activate Update Listener.

Returns: boolean Activate Update Listener

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

        {
                return $this->enableupdatelistener;
        }

References $enableupdatelistener.

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

Here is the caller graph for this function:

◆ getHeight()

ilMapGUI::getHeight ( )

Get Height.

Returns: string Height

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

        {
                return $this->height;
        }

References $height.

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

Here is the caller graph for this function:

◆ getHtml()

ilMapGUI::getHtml ( )

abstract

Get HTML.

Reimplemented in ilGoogleMapGUI, and ilOpenLayersMapGUI.

◆ getLatitude()

ilMapGUI::getLatitude ( )

Get Latitude.

Returns: string Latitude

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

        {
                return $this->latitude;
        }

References $latitude.

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

Here is the caller graph for this function:

◆ getLongitude()

ilMapGUI::getLongitude ( )

Get Longitude.

Returns: string Longitude

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

        {
                return $this->longitude;
        }

References $longitude.

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

Here is the caller graph for this function:

◆ getMapId()

ilMapGUI::getMapId ( )

Get Map ID.

Returns: string Map ID

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

        {
                return $this->mapid;
        }

References $mapid.

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

Here is the caller graph for this function:

◆ getUserListHtml()

ilMapGUI::getUserListHtml ( )

abstract

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

Reimplemented in ilGoogleMapGUI, and ilOpenLayersMapGUI.

◆ getWidth()

ilMapGUI::getWidth ( )

Get Width.

Returns: string Width

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

        {
                return $this->width;
        }

References $width.

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

Here is the caller graph for this function:

◆ getZoom()

ilMapGUI::getZoom ( )

Get Zoom.

Returns: int Zoom

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

        {
                return $this->zoom;
        }

References $zoom.

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

Here is the caller graph for this function:

◆ setEnableCentralMarker()

ilMapGUI::setEnableCentralMarker ( $a_centralmarker )

Enable Central Marker.

Parameters

boolean $a_centralmarker Central Marker

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

        {
                $this->centralmarker = $a_centralmarker;
                return $this;
        }

◆ setEnableLargeMapControl()

ilMapGUI::setEnableLargeMapControl ( $a_largemapcontrol )

Set Large Map Control.

Parameters

boolean $a_largemapcontrol Large Map Control

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

        {
                $this->largemapcontrol = $a_largemapcontrol;
                return $this;
        }

◆ setEnableNavigationControl()

ilMapGUI::setEnableNavigationControl ( $a_enablenavigationcontrol )

Set Use Navigation Control.

Parameters

boolean $a_enablenavigationcontrol Use Navigation Control

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

        {
                $this->enablenavigationcontrol = $a_enablenavigationcontrol;
                return $this;
        }

◆ setEnableTypeControl()

ilMapGUI::setEnableTypeControl ( $a_enabletypecontrol )

Set Use Map Type Control.

Parameters

boolean $a_enabletypecontrol Use Map Type Control

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

        {
                $this->enabletypecontrol = $a_enabletypecontrol;
                return $this;
        }

◆ setEnableUpdateListener()

ilMapGUI::setEnableUpdateListener ( $a_enableupdatelistener )

Set Activate Update Listener.

Parameters

boolean $a_enableupdatelistener Activate Update Listener

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

        {
                $this->enableupdatelistener = $a_enableupdatelistener;
                return $this;
        }

◆ setHeight()

ilMapGUI::setHeight ( $a_height )

Set Height.

Parameters

string $a_height Height

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

        {
                $this->height = $a_height;
                return $this;
        }

◆ setLatitude()

ilMapGUI::setLatitude ( $a_latitude )

Set Latitude.

Parameters

string $a_latitude Latitude

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

        {
                $this->latitude = $a_latitude;
                return $this;
        }

◆ setLongitude()

ilMapGUI::setLongitude ( $a_longitude )

Set Longitude.

Parameters

string $a_longitude Longitude

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

        {
                $this->longitude = $a_longitude;
                return $this;
        }

◆ setMapId()

ilMapGUI::setMapId ( $a_mapid )

Set Map ID.

Parameters

string $a_mapid Map ID

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

        {
                $this->mapid = $a_mapid;
                return $this;
        }

◆ setWidth()

ilMapGUI::setWidth ( $a_width )

Set Width.

Parameters

string $a_width Width

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

        {
                $this->width = $a_width;
                return $this;
        }

◆ setZoom()

ilMapGUI::setZoom ( $a_zoom )

Set Zoom.

Parameters

int $a_zoom Zoom

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

        {
                $this->zoom = $a_zoom;
                return $this;
        }

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:

Services/Maps/classes/class.ilMapGUI.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addUserMarker()

◆ getEnableCentralMarker()

◆ getEnableLargeMapControl()

◆ getEnableNavigationControl()

◆ getEnableTypeControl()

◆ getEnableUpdateListener()

◆ getHeight()

◆ getHtml()

◆ getLatitude()

◆ getLongitude()

◆ getMapId()

◆ getUserListHtml()

◆ getWidth()

◆ getZoom()

◆ setEnableCentralMarker()

◆ setEnableLargeMapControl()

◆ setEnableNavigationControl()

◆ setEnableTypeControl()

◆ setEnableUpdateListener()

◆ setHeight()

◆ setLatitude()

◆ setLongitude()

◆ setMapId()

◆ setWidth()

◆ setZoom()

Field Documentation

◆ $enablelargemapcontrol

◆ $enablenavigationcontrol

◆ $enabletypecontrol

◆ $enableupdatelistener

◆ $height

◆ $latitude

◆ $longitude

◆ $mapid

◆ $user_marker

◆ $width

◆ $zoom