Collaboration diagram for ilMapUtil:

Static Public Member Functions
static	settings ()

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

static	setActivated (bool $activated)

static	setType (string $type)

static	getType ()

static	setStdLatitude (string $lat)

static	getStdLatitude ()

static	setStdLongitude (string $lon)

static	getStdLongitude ()

static	setStdZoom (string $zoom)

static	getStdZoom ()

static	setApiKey (string $api_key)

static	getApiKey ()

static	setStdTileServers (string $tile)

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

static	setStdGeolocationServer ($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 ilSetting	$_settings = null

Detailed Description

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

Member Function Documentation

◆ getApiKey()

static ilMapUtil::getApiKey ( )

static

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

References ILIAS\Repository\settings().

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

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

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<string, string>

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

References $DIC, and $lng.

Referenced by ilObjExternalToolsSettingsGUI\getMapsForm().

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

Here is the caller graph for this function:

◆ getDefaultSettings()

static ilMapUtil::getDefaultSettings ( )

static

Get default longitude, latitude and zoom.

Returns: array<string, string>

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

References ILIAS\Repository\settings().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMapGUI()

static ilMapUtil::getMapGUI ( )

static

Get an instance of the GUI class.

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

Referenced by ilPublicUserProfileGUI\getEmbeddable(), ilADTLocationPresentationBridge\getHTML(), ilLocationInputGUI\insert(), ilMembershipGUI\membersMap(), and ilPCMap\modifyPageContentPostXsl().

                                       : ilMapGui
     {
         $type = self::getType();
         switch ($type) {
             case "openlayers":
                 $map = new ilOpenLayersMapGUI();
                 $map->setTileServers(self::getStdTileServers());
                 $map->setGeolocationServer(self::getStdGeolocationServer());
                 return $map;
             default:
                 return new ilGoogleMapGUI();
         }
     }

Here is the caller graph for this function:

◆ getStdGeolocationServer()

static ilMapUtil::getStdGeolocationServer ( )

static

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

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

References ILIAS\Repository\settings().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStdLatitude()

static ilMapUtil::getStdLatitude ( )

static

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

References ILIAS\Repository\settings().

Referenced by ilObjExternalToolsSettingsGUI\getMapsForm().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStdLongitude()

static ilMapUtil::getStdLongitude ( )

static

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

References ILIAS\Repository\settings().

Referenced by ilObjExternalToolsSettingsGUI\getMapsForm().

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

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

References ILIAS\Repository\settings().

Referenced by ilObjExternalToolsSettingsGUI\getMapsForm().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStdZoom()

static ilMapUtil::getStdZoom ( )

static

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

References ILIAS\Repository\settings().

Referenced by ilObjExternalToolsSettingsGUI\getMapsForm().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getType()

static ilMapUtil::getType ( )

static

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

References ILIAS\Repository\settings().

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

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

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.

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

References ILIAS\Repository\settings().

Referenced by ilPersonalProfileGUI\addLocationToForm(), ilObjGroupGUI\editMapSettingsObject(), ilObjCourseGUI\editMapSettingsObject(), ilPublicUserProfileGUI\getEmbeddable(), ilObjExternalToolsSettingsGUI\getMapsForm(), ilMembershipGUI\membersMap(), ilPersonalProfileGUI\savePersonalDataForm(), ilMembershipGUI\setSubTabs(), ilObjCourseGUI\setSubTabs(), ilObjGroupGUI\setSubTabs(), ilPageObjectGUI\showPage(), and ilPersonalProfileGUI\showPublicProfileFields().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setActivated()

static ilMapUtil::setActivated ( bool $activated )

static

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

References ILIAS\Repository\settings().

Referenced by ilObjExternalToolsSettingsGUI\saveMapsObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setApiKey()

static ilMapUtil::setApiKey ( string $api_key )

static

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

References ILIAS\Repository\settings().

Referenced by ilObjExternalToolsSettingsGUI\saveMapsObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setStdGeolocationServer()

static ilMapUtil::setStdGeolocationServer ( $geolocation )

static

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

References ILIAS\Repository\settings().

Referenced by ilObjExternalToolsSettingsGUI\saveMapsObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setStdLatitude()

static ilMapUtil::setStdLatitude ( string $lat )

static

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

References ILIAS\Repository\settings().

Referenced by ilObjExternalToolsSettingsGUI\saveMapsObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setStdLongitude()

static ilMapUtil::setStdLongitude ( string $lon )

static

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

References ILIAS\Repository\settings().

Referenced by ilObjExternalToolsSettingsGUI\saveMapsObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setStdTileServers()

static ilMapUtil::setStdTileServers ( string $tile )

static

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

References ILIAS\Repository\settings().

Referenced by ilObjExternalToolsSettingsGUI\saveMapsObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setStdZoom()

static ilMapUtil::setStdZoom ( string $zoom )

static

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

References ILIAS\Repository\settings().

Referenced by ilObjExternalToolsSettingsGUI\saveMapsObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ settings()

static ilMapUtil::settings ( )

static

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

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

◆ setType()

static ilMapUtil::setType ( string $type )

static

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

References ILIAS\Repository\settings().

Referenced by ilObjExternalToolsSettingsGUI\saveMapsObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $_settings

ilSetting ilMapUtil::$_settings = null

static

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

◆ DEFAULT_GEOLOCATION

const ilMapUtil::DEFAULT_GEOLOCATION = null

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

◆ DEFAULT_TILE

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

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

Referenced by ilObjExternalToolsSettingsGUI\getMapsForm().

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

components/ILIAS/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