User interface class for OpenLayers maps. More...

Inheritance diagram for ilOpenLayersMapGUI:

Collaboration diagram for ilOpenLayersMapGUI:

Public Member Functions
	__construct ()

	getTileServers ()

	setTileServers (string $tile)

	getGeolocationServer ()

	setGeolocationServer (?string $geolocation)

	initJSandCSS ()

	getHtml (bool $inline_js=false)

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

Public Member Functions inherited from ilMapGUI
	__construct ()

	setMapId (string $map_id)

	getMapId ()

	setWidth (string $width)

	getWidth ()

	setHeight (string $height)

	getHeight ()

	setLatitude (string $latitude)

	getLatitude ()

	setLongitude (string $longitude)

	getLongitude ()

	setZoom (?int $zoom)

	getZoom ()

	setEnableTypeControl (bool $enable_type_control)

	getEnableTypeControl ()

	setEnableNavigationControl (bool $enable_navigation_control)

	getEnableNavigationControl ()

	setEnableUpdateListener (bool $enable_update_listener)

	getEnableUpdateListener ()

	setEnableLargeMapControl (bool $large_map_control)

	getEnableLargeMapControl ()

	setEnableCentralMarker (bool $central_marker)

	getEnableCentralMarker ()

	addUserMarker (int $user_id)

	getHtml ()

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

Protected Attributes
string	$css_row

string	$tile_server

string	$geolocation_server

Protected Attributes inherited from ilMapGUI
ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

string	$map_id

string	$width

string	$height

string	$latitude

string	$longitude

int	$zoom

bool	$enable_type_control

bool	$enable_update_listener

bool	$enable_navigation_control

array	$user_marker

bool	$large_map_control

bool	$central_marker

Detailed Description

User interface class for OpenLayers maps.

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

Constructor & Destructor Documentation

◆ __construct()

ilOpenLayersMapGUI::__construct ( )

Definition at line 16 of file class.ilOpenLayersMapGUI.php.

References ILIAS\GlobalScreen\Provider\__construct().

     {
         parent::__construct();
 
         $this->css_row = "";
         $this->tile_server = "";
         $this->geolocation_server = "";
     }

Here is the call graph for this function:

Member Function Documentation

◆ getGeolocationServer()

ilOpenLayersMapGUI::getGeolocationServer ( )

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

References $geolocation_server.

Referenced by getHtml().

                                           : ?string
     {
         return $this->geolocation_server;
     }

Here is the caller graph for this function:

◆ getHtml()

ilOpenLayersMapGUI::getHtml ( bool $inline_js = false )

Definition at line 54 of file class.ilOpenLayersMapGUI.php.

References ilMapGUI\$central_marker, $out, ilObject\_exists(), ilMapGUI\getEnableCentralMarker(), ilMapGUI\getEnableNavigationControl(), ilMapGUI\getEnableUpdateListener(), getGeolocationServer(), ilMapGUI\getHeight(), ilMapGUI\getLatitude(), ilMapGUI\getLongitude(), ilMapGUI\getMapId(), getTileServers(), ilMapGUI\getWidth(), ilMapGUI\getZoom(), initJSandCSS(), and ILIAS\Repository\lng().

                                                     : string
     {
         $this->initJSandCSS();
         $this->lng->loadLanguageModule("maps");
 
         $html_tpl = new ilTemplate(
             "tpl.openlayers_map.html",
             true,
             true,
             "Services/Maps"
         );
 
         $js_tpl = new ilTemplate(
             "tpl.openlayers_map.js",
             true,
             true,
             "Services/Maps"
         );
 
         // add user markers
         $cnt = 0;
         foreach ($this->user_marker as $user_id) {
             if (ilObject::_exists($user_id)) {
                 $user = new ilObjUser($user_id);
                 if ($user->getLatitude() != 0 && $user->getLongitude() != 0 &&
                     $user->getPref("public_location") == "y") {
                     $js_tpl->setCurrentBlock("user_marker");
                     $js_tpl->setVariable(
                         "UMAP_ID",
                         $this->getMapId()
                     );
                     $js_tpl->setVariable("CNT", $cnt);
 
                     $js_tpl->setVariable("ULAT", htmlspecialchars($user->getLatitude()));
                     $js_tpl->setVariable("ULONG", htmlspecialchars($user->getLongitude()));
                     $info = htmlspecialchars($user->getFirstName() . " " . $user->getLastName());
                     $delim = "<br />";
                     if ($user->getPref("public_institution") == "y") {
                         $info .= $delim . htmlspecialchars($user->getInstitution());
                         $delim = ", ";
                     }
                     if ($user->getPref("public_department") == "y") {
                         $info .= $delim . htmlspecialchars($user->getDepartment());
                     }
                     $delim = "<br />";
                     if ($user->getPref("public_street") == "y") {
                         $info .= $delim . htmlspecialchars($user->getStreet());
                     }
                     if ($user->getPref("public_zip") == "y") {
                         $info .= $delim . htmlspecialchars($user->getZipcode());
                         $delim = " ";
                     }
                     if ($user->getPref("public_city") == "y") {
                         $info .= $delim . htmlspecialchars($user->getCity());
                     }
                     $delim = "<br />";
                     if ($user->getPref("public_country") == "y") {
                         $info .= $delim . htmlspecialchars($user->getCountry());
                     }
                     $js_tpl->setVariable(
                         "USER_INFO",
                         $info
                     );
                     $js_tpl->setVariable(
                         "IMG_USER",
                         $user->getPersonalPicturePath("xsmall")
                     );
                     $js_tpl->parseCurrentBlock();
                     $cnt++;
                 }
             }
         }
 
         $html_tpl->setVariable("MAP_ID", $this->getMapId());
         $html_tpl->setVariable("WIDTH", $this->getWidth());
         $html_tpl->setVariable("HEIGHT", $this->getHeight());
 
         $js_tpl->setVariable("MAP_ID", $this->getMapId());
         $js_tpl->setVariable("LAT", $this->getLatitude());
         $js_tpl->setVariable("LONG", $this->getLongitude());
         $js_tpl->setVariable("ZOOM", (int) $this->getZoom());
 
         $nav_control = $this->getEnableNavigationControl()
             ? "true"
             : "false";
         $js_tpl->setVariable("NAV_CONTROL", $nav_control);
         $central_marker = $this->getEnableCentralMarker()
             ? "true"
             : "false";
         $js_tpl->setVariable("CENTRAL_MARKER", $central_marker);
         $replace_marker = $this->getEnableUpdateListener()
             ? "true"
             : "false";
         $js_tpl->setVariable("REPLACE_MARKER", $replace_marker);
 
         $tile_servers = $this->getTileServers();
         $tile_servers = explode(" ", $tile_servers);
         array_walk($tile_servers, function (&$string) {
             $string = '"' . $string . '"';
         });
         $tile_servers = '[' . implode(', ', $tile_servers) . ']';
 
         $js_tpl->setVariable("TILES", $tile_servers);
         $js_tpl->setVariable("GEOLOCATION", $this->getGeolocationServer());
         $js_tpl->setVariable("INVALID_ADDRESS_STRING", $this->lng->txt("invalid_address"));
 
         $out = $html_tpl->get();
         if (! $inline_js) {
             $this->tpl->addOnLoadCode($js_tpl->get());
         } else {
             $out .= '<script>' .$js_tpl->get() . '</script>';
         }
         return $out;
     }

Here is the call graph for this function:

◆ getTileServers()

ilOpenLayersMapGUI::getTileServers ( )

Definition at line 25 of file class.ilOpenLayersMapGUI.php.

References $tile_server.

Referenced by getHtml().

                                     : string
     {
         return  $this->tile_server;
     }

Here is the caller graph for this function:

◆ getUserListHtml()

ilOpenLayersMapGUI::getUserListHtml ( )

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

Definition at line 172 of file class.ilOpenLayersMapGUI.php.

References ilObject\_exists(), and ilMapGUI\getMapId().

                                      : string
     {
         $list_tpl = new ilTemplate(
             "tpl.openlayers_map_user_list.html",
             true,
             true,
             "Services/Maps"
         );
 
         $cnt = 0;
         foreach ($this->user_marker as $user_id) {
             if (ilObject::_exists($user_id)) {
                 $user = new ilObjUser($user_id);
                 $this->css_row = ($this->css_row != "tblrow1_mo")
                     ? "tblrow1_mo"
                     : "tblrow2_mo";
                 if ($user->getLatitude() != 0 && $user->getLongitude() != 0
                     && $user->getPref("public_location") == "y") {
                     $list_tpl->setCurrentBlock("item");
                     $list_tpl->setVariable("MARKER_CNT", $cnt);
                     $list_tpl->setVariable("MAP_ID", $this->getMapId());
                     $cnt++;
                 } else {
                     $list_tpl->setCurrentBlock("item_no_link");
                 }
                 $list_tpl->setVariable("CSS_ROW", $this->css_row);
                 $list_tpl->setVariable("TXT_USER", $user->getLogin());
                 $list_tpl->setVariable(
                     "IMG_USER",
                     $user->getPersonalPicturePath("xxsmall")
                 );
                 $list_tpl->parseCurrentBlock();
                 $list_tpl->touchBlock("row");
             }
         }
 
         return $list_tpl->get();
     }

Here is the call graph for this function:

◆ initJSandCSS()

ilOpenLayersMapGUI::initJSandCSS ( )

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

Referenced by getHtml().

                                   : void
     {
         $this->tpl->addCss("node_modules/ol/ol.css");
         $this->tpl->addCss("Services/Maps/css/service_openlayers.css");
         $this->tpl->addJavaScript("Services/Maps/js/dist/ServiceOpenLayers.js");
     }

Here is the caller graph for this function:

◆ setGeolocationServer()

ilOpenLayersMapGUI::setGeolocationServer ( ?string $geolocation )

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

                                                               : ilOpenLayersMapGUI
     {
         $this->geolocation_server = $geolocation;
         return $this;
     }

◆ setTileServers()

ilOpenLayersMapGUI::setTileServers ( string $tile )

Definition at line 30 of file class.ilOpenLayersMapGUI.php.

                                                 : ilOpenLayersMapGUI
     {
         $this->tile_server = $tile;
         return $this;
     }

Field Documentation

◆ $css_row

string ilOpenLayersMapGUI::$css_row

protected

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

◆ $geolocation_server

string ilOpenLayersMapGUI::$geolocation_server

protected

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

Referenced by getGeolocationServer().

◆ $tile_server

string ilOpenLayersMapGUI::$tile_server

protected

Definition at line 13 of file class.ilOpenLayersMapGUI.php.

Referenced by getTileServers().

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

Services/Maps/classes/class.ilOpenLayersMapGUI.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getGeolocationServer()

◆ getHtml()

◆ getTileServers()

◆ getUserListHtml()

◆ initJSandCSS()

◆ setGeolocationServer()

◆ setTileServers()

Field Documentation

◆ $css_row

◆ $geolocation_server

◆ $tile_server