ilOpenLayersMapGUI Class Reference

User interface class for OpenLayers maps. More...

Inheritance diagram for ilOpenLayersMapGUI:

Collaboration diagram for ilOpenLayersMapGUI:

Public Member Functions
	__construct ()
	getTileServers ()
	Get HTML. More...
	setTileServers ($a_tile)
	getGeolocationServer ()
	setGeolocationServer ($a_geolocation)
	getHtml ()
	getUserListHtml ()
	Get User List HTML (to be displayed besides the map) More...
Public Member Functions inherited from ilMapGUI
	__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
	$tile_server
	$geolocation_server
Protected Attributes inherited from ilMapGUI
	$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 OpenLayers 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 35 of file class.ilOpenLayersMapGUI.php.

Constructor & Destructor Documentation

__construct()

ilOpenLayersMapGUI::__construct

(

)

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

    {
        parent::__construct();
    }

Member Function Documentation

getGeolocationServer()

ilOpenLayersMapGUI::getGeolocationServer

(

)

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

References $geolocation_server.

Referenced by getHtml().

    {
        return $this->geolocation_server;
    }

Here is the caller graph for this function:

getHtml()

ilOpenLayersMapGUI::getHtml

(

)

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

References $DIC, $https, $info, $lng, $tpl, ilObject\_exists(), ilMapGUI\getEnableCentralMarker(), ilMapGUI\getEnableNavigationControl(), ilMapGUI\getEnableUpdateListener(), getGeolocationServer(), ilMapGUI\getHeight(), ilMapGUI\getLatitude(), ilMapGUI\getLongitude(), ilMapGUI\getMapId(), getTileServers(), ilMapGUI\getWidth(), and ilMapGUI\getZoom().

    {
        global $DIC;
        $tpl = $DIC['tpl'];
        $lng = $DIC['lng'];
        $https = $DIC['https'];

        $this->tpl = new ilTemplate(
            "tpl.openlayers_map.html",
            true,
            true,
            "Services/Maps"
        );


        $lng->loadLanguageModule("maps");
        $tpl->addCss("libs/bower/bower_components/OpenLayers/ol.css");
        $tpl->addJavaScript("libs/bower/bower_components/OpenLayers/ol.js");
        $tpl->addCss("Services/Maps/css/service_openlayers.css");
        $tpl->addJavaScript("Services/Maps/js/ServiceOpenLayers.js");

        // 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") {
                    $this->tpl->setCurrentBlock("user_marker");
                    $this->tpl->setVariable(
                        "UMAP_ID",
                        $this->getMapId()
                    );
                    $this->tpl->setVariable("CNT", $cnt);

                    $this->tpl->setVariable("ULAT", htmlspecialchars($user->getLatitude()));
                    $this->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());
                    }
                    $this->tpl->setVariable(
                        "USER_INFO",
                        $info
                    );
                    $this->tpl->setVariable(
                        "IMG_USER",
                        $user->getPersonalPicturePath("xsmall")
                    );
                    $this->tpl->parseCurrentBlock();
                    $cnt++;
                }
            }
        }

        $this->tpl->setVariable("MAP_ID", $this->getMapId());
        $this->tpl->setVariable("WIDTH", $this->getWidth());
        $this->tpl->setVariable("HEIGHT", $this->getHeight());
        $this->tpl->setVariable("LAT", $this->getLatitude());
        $this->tpl->setVariable("LONG", $this->getLongitude());
        $this->tpl->setVariable("ZOOM", (int) $this->getZoom());


        $nav_control = $this->getEnableNavigationControl()
            ? "true"
            : "false";
        $this->tpl->setVariable("NAV_CONTROL", $nav_control);
        $central_marker = $this->getEnableCentralMarker()
            ? "true"
            : "false";
        $this->tpl->setVariable("CENTRAL_MARKER", $central_marker);
        $replace_marker = $this->getEnableUpdateListener()
            ? "true"
            : "false";
        $this->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) . ']';

        $this->tpl->setVariable("TILES", $tile_servers);
        $this->tpl->setVariable("GEOLOCATION", $this->getGeolocationServer());
        $this->tpl->setVariable("INVALID_ADDRESS_STRING", $lng->txt("invalid_address"));

        return $this->tpl->get();
    }

Here is the call graph for this function:

getTileServers()

ilOpenLayersMapGUI::getTileServers

(

)

Get HTML.

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

References $tile_server.

Referenced by getHtml().

    {
        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 185 of file class.ilOpenLayersMapGUI.php.

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

    {
        $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:

setGeolocationServer()

ilOpenLayersMapGUI::setGeolocationServer

(

$a_geolocation

)

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

    {
        $this->geolocation_server = $a_geolocation;
        return $this;
    }

setTileServers()

ilOpenLayersMapGUI::setTileServers

(

$a_tile

)

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

    {
        $this->tile_server = $a_tile;
        return $this;
    }

Field Documentation

$geolocation_server

ilOpenLayersMapGUI::$geolocation_server

protected

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

Referenced by getGeolocationServer().

$tile_server

ilOpenLayersMapGUI::$tile_server

protected

Definition at line 37 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