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	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...

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 110 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 152 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 120 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 131 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");
                                return new ilOpenLayersMapGUI();
                        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:

◆ getStdLatitude()

static ilMapUtil::getStdLatitude ( )

static

Definition at line 80 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 90 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:

◆ getStdZoom()

static ilMapUtil::getStdZoom ( )

static

Definition at line 100 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 71 of file class.ilMapUtil.php.

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

References settings().

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

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 54 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 61 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 105 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:

◆ setStdLatitude()

static ilMapUtil::setStdLatitude ( $a_lat )

static

Definition at line 75 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 85 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:

◆ setStdZoom()

static ilMapUtil::setStdZoom ( $a_zoom )

static

Definition at line 95 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 38 of file class.ilMapUtil.php.

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

References $_settings.

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

Here is the caller graph for this function:

◆ setType()

static ilMapUtil::setType ( $a_type )

static

Definition at line 66 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().

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

Services/Maps/classes/class.ilMapUtil.php

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ getApiKey()

◆ getAvailableMapTypes()

◆ getDefaultSettings()

◆ getMapGUI()

◆ getStdLatitude()

◆ getStdLongitude()

◆ getStdZoom()

◆ getType()

◆ isActivated()

◆ setActivated()

◆ setApiKey()

◆ setStdLatitude()

◆ setStdLongitude()

◆ setStdZoom()

◆ settings()

◆ setType()

Field Documentation

◆ $_settings