Map Utility Class. More...

Collaboration diagram for ilMapUtil:

Static Public Member Functions
static	settings ()

static	isActivated ()
	Checks whether Map feature is activated. More...

static	setActivated ($a_activated)

static	setType ($a_type)

static	getType ()

static	setStdLatitude ($a_lat)

static	getStdLatitude ()

static	setStdLongitude ($a_lon)

static	getStdLongitude ()

static	setStdZoom ($a_zoom)

static	getStdZoom ()

static	setApiKey ($a_api_key)

static	getApiKey ()

static	setStdTileServers ($a_tile)

static	getStdTileServers ()
	Returns the tile server to be used in the installation. More...

static	setStdGeolocationServer ($a_geolocation)

static	getStdGeolocationServer ()
	Returns the reverse geolocation server to be used in the installation. More...

static	getDefaultSettings ()
	Get default longitude, latitude and zoom. More...

static	getMapGUI ()
	Get an instance of the GUI class. More...

static	getAvailableMapTypes ()
	Get a dict { $id => $name } for available maps services. More...

Data Fields
const	DEFAULT_TILE = "a.tile.openstreetmap.org b.tile.openstreetmap.org c.tile.openstreetmap.org"

const	DEFAULT_GEOLOCATION = null

Static Public Attributes
static	$_settings = null

Detailed Description

Map Utility Class.

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 32 of file class.ilMapUtil.php.

Member Function Documentation

◆ getApiKey()

static ilMapUtil::getApiKey ( )

static

Definition at line 113 of file class.ilMapUtil.php.

        {
                return self::settings()->get("api_key");
        }

References settings().

Referenced by ilObjExternalToolsSettingsGUI\editMapsObject(), and ilGoogleMapGUI\getHtml().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAvailableMapTypes()

static ilMapUtil::getAvailableMapTypes ( )

static

Get a dict { $id => $name } for available maps services.

Returns: array

Definition at line 191 of file class.ilMapUtil.php.

        {
                global $lng;
                $lng->loadLanguageModule("maps");
                return array( "openlayers"      => $lng->txt("maps_open_layers_maps")
                                        , "googlemaps"  => $lng->txt("maps_google_maps")
                                        );
        }

References $lng.

Referenced by ilObjExternalToolsSettingsGUI\editMapsObject().

Here is the caller graph for this function:

◆ getDefaultSettings()

static ilMapUtil::getDefaultSettings ( )

static

Get default longitude, latitude and zoom.

Returns: array array("latitude", "longitude", "zoom")

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

        {
                return array(
                        "longitude" => self::settings()->get("std_longitude"),
                        "latitude" => self::settings()->get("std_latitude"),
                        "zoom" => self::settings()->get("std_zoom"));
        }

Referenced by ilPersonalProfileGUI\addLocationToForm(), ilADTLocationFormBridge\addToForm(), ilADTLocationSearchBridgeSingle\addToForm(), ilObjCourseGUI\editMapSettingsObject(), and ilObjGroupGUI\editMapSettingsObject().

Here is the caller graph for this function:

◆ getMapGUI()

static ilMapUtil::getMapGUI ( )

static

Get an instance of the GUI class.

Definition at line 167 of file class.ilMapUtil.php.

        {
                $type = self::getType();
                switch ($type) {
                        case "googlemaps":
                                require_once("Services/Maps/classes/class.ilGoogleMapGUI.php");
                                return new ilGoogleMapGUI();
                        case "openlayers":
                                require_once("Services/Maps/classes/class.ilOpenLayersMapGUI.php");
                                 $map = new ilOpenLayersMapGUI();
                                 $map->setTileServers(self::getStdTileServers());
                                 $map->setGeolocationServer(self::getStdGeolocationServer());
                                 return $map;
                        default:
                                require_once("Services/Maps/classes/class.ilGoogleMapGUI.php");
                                return new ilGoogleMapGUI();
                }
        }

References getType().

Referenced by ilPublicUserProfileGUI\getEmbeddable(), ilADTLocationPresentationBridge\getHTML(), ilLocationInputGUI\insert(), ilObjCourseGUI\membersMapObject(), ilObjGroupGUI\membersMapObject(), and ilPCMap\modifyPageContentPostXsl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStdGeolocationServer()

static ilMapUtil::getStdGeolocationServer ( )

static

Returns the reverse geolocation server to be used in the installation.

Returns: string tile server url

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

        {
                $std_geoloc = self::settings()->get("std_geolocation");
                return $std_geoloc ? $std_geoloc : self::DEFAULT_GEOLOCATION;
        }

References DEFAULT_GEOLOCATION, and settings().

Referenced by ilObjExternalToolsSettingsGUI\editMapsObject(), and ilLocationInputGUI\geolocationAvailiable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStdLatitude()

static ilMapUtil::getStdLatitude ( )

static

Definition at line 83 of file class.ilMapUtil.php.

        {
                return self::settings()->get("std_latitude");
        }

References settings().

Referenced by ilObjExternalToolsSettingsGUI\editMapsObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStdLongitude()

static ilMapUtil::getStdLongitude ( )

static

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

        {
                return self::settings()->get("std_longitude");
        }

References settings().

Referenced by ilObjExternalToolsSettingsGUI\editMapsObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStdTileServers()

static ilMapUtil::getStdTileServers ( )

static

Returns the tile server to be used in the installation.

Returns: string tile server url

Definition at line 128 of file class.ilMapUtil.php.

        {
                $std_tile = self::settings()->get("std_tile");  
                return $std_tile ? $std_tile : self::DEFAULT_TILE;
        }

References DEFAULT_TILE, and settings().

Referenced by ilObjExternalToolsSettingsGUI\editMapsObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStdZoom()

static ilMapUtil::getStdZoom ( )

static

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

        {
                return self::settings()->get("std_zoom");
        }

References settings().

Referenced by ilObjExternalToolsSettingsGUI\editMapsObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getType()

static ilMapUtil::getType ( )

static

Definition at line 74 of file class.ilMapUtil.php.

                                  {
                return self::settings()->get("type");
        }

References settings().

Referenced by ilObjExternalToolsSettingsGUI\editMapsObject(), ilLocationInputGUI\geolocationAvailiable(), getMapGUI(), and ilObjExternalToolsSettingsGUI\saveMapsObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isActivated()

static ilMapUtil::isActivated ( )

static

Checks whether Map feature is activated.

API key must be provided.

Returns: boolean activated true/false

Definition at line 57 of file class.ilMapUtil.php.

        {
                return self::settings()->get("enable") == 1;
        }

References settings().

Referenced by ilPersonalProfileGUI\addLocationToForm(), ilObjCourseGUI\editMapSettingsObject(), ilObjGroupGUI\editMapSettingsObject(), ilObjExternalToolsSettingsGUI\editMapsObject(), ilPublicUserProfileGUI\getEmbeddable(), ilObjCourseGUI\membersMapObject(), ilObjGroupGUI\membersMapObject(), ilPersonalProfileGUI\savePersonalData(), ilObjCourseGUI\setSubTabs(), ilObjGroupGUI\setSubTabs(), ilPageObjectGUI\showPage(), and ilPersonalProfileGUI\showPublicProfileFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setActivated()

static ilMapUtil::setActivated ( $a_activated )

static

Definition at line 64 of file class.ilMapUtil.php.

        {
                self::settings()->set("enable", $a_activated?"1":"0");
        }

References settings().

Referenced by ilObjExternalToolsSettingsGUI\saveMapsObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setApiKey()

static ilMapUtil::setApiKey ( $a_api_key )

static

Definition at line 108 of file class.ilMapUtil.php.

        {
                self::settings()->set("api_key", $a_api_key);
        }

References settings().

Referenced by ilObjExternalToolsSettingsGUI\saveMapsObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setStdGeolocationServer()

static ilMapUtil::setStdGeolocationServer ( $a_geolocation )

static

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

        {
                self::settings()->set("std_geolocation", $a_geolocation);
        }

References settings().

Referenced by ilObjExternalToolsSettingsGUI\saveMapsObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setStdLatitude()

static ilMapUtil::setStdLatitude ( $a_lat )

static

Definition at line 78 of file class.ilMapUtil.php.

        {
                self::settings()->set("std_latitude", $a_lat);
        }

References settings().

Referenced by ilObjExternalToolsSettingsGUI\saveMapsObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setStdLongitude()

static ilMapUtil::setStdLongitude ( $a_lon )

static

Definition at line 88 of file class.ilMapUtil.php.

        {
                self::settings()->set("std_longitude", $a_lon);
        }

References settings().

Referenced by ilObjExternalToolsSettingsGUI\saveMapsObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setStdTileServers()

static ilMapUtil::setStdTileServers ( $a_tile )

static

Definition at line 118 of file class.ilMapUtil.php.

        {
                self::settings()->set("std_tile", $a_tile);
        }

References settings().

Referenced by ilObjExternalToolsSettingsGUI\saveMapsObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setStdZoom()

static ilMapUtil::setStdZoom ( $a_zoom )

static

Definition at line 98 of file class.ilMapUtil.php.

        {
                self::settings()->set("std_zoom", $a_zoom);
        }

References settings().

Referenced by ilObjExternalToolsSettingsGUI\saveMapsObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ settings()

static ilMapUtil::settings ( )

static

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

        {
                if (self::$_settings === null) {
                        self::$_settings = new ilSetting("maps");
                }
                return self::$_settings;
        }

References $_settings.

Referenced by getApiKey(), getStdGeolocationServer(), getStdLatitude(), getStdLongitude(), getStdTileServers(), getStdZoom(), getType(), isActivated(), setActivated(), setApiKey(), setStdGeolocationServer(), setStdLatitude(), setStdLongitude(), setStdTileServers(), setStdZoom(), and setType().

Here is the caller graph for this function:

◆ setType()

static ilMapUtil::setType ( $a_type )

static

Definition at line 69 of file class.ilMapUtil.php.

        {
                self::settings()->set("type", $a_type);
        }

References settings().

Referenced by ilObjExternalToolsSettingsGUI\saveMapsObject().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $_settings

ilMapUtil::$_settings = null

static

Definition at line 34 of file class.ilMapUtil.php.

Referenced by settings().

◆ DEFAULT_GEOLOCATION

const ilMapUtil::DEFAULT_GEOLOCATION = null

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

Referenced by getStdGeolocationServer().

◆ DEFAULT_TILE

const ilMapUtil::DEFAULT_TILE = "a.tile.openstreetmap.org b.tile.openstreetmap.org c.tile.openstreetmap.org"

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

Referenced by ilObjExternalToolsSettingsGUI\editMapsObject(), and getStdTileServers().

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

Services/Maps/classes/class.ilMapUtil.php

Static Public Member Functions

Data Fields

Static Public Attributes

Detailed Description

Member Function Documentation

◆ getApiKey()

◆ getAvailableMapTypes()

◆ getDefaultSettings()

◆ getMapGUI()

◆ getStdGeolocationServer()

◆ getStdLatitude()

◆ getStdLongitude()

◆ getStdTileServers()

◆ getStdZoom()

◆ getType()

◆ isActivated()

◆ setActivated()

◆ setApiKey()

◆ setStdGeolocationServer()

◆ setStdLatitude()

◆ setStdLongitude()

◆ setStdTileServers()

◆ setStdZoom()

◆ settings()

◆ setType()

Field Documentation

◆ $_settings

◆ DEFAULT_GEOLOCATION

◆ DEFAULT_TILE