This class represents a location property in a property form. More...

Inheritance diagram for ilLocationInputGUI:

Collaboration diagram for ilLocationInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. 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...

	setAddress ($a_address)
	Set Address. More...

	getAddress ()
	Get Address. More...

	setValueByArray ($a_values)
	Set value by array. More...

	checkInput ()
	Check input, strip slashes etc. More...

	insert ($a_tpl)
	Insert property html. More...

Public Member Functions inherited from ilFormPropertyGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	executeCommand ()
	Execute command. More...

	getType ()
	Get Type. More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setPostVar ($a_postvar)
	Set Post Variable. More...

	getPostVar ()
	Get Post Variable. More...

	getFieldId ()
	Get Post Variable. More...

	setInfo ($a_info)
	Set Information Text. More...

	getInfo ()
	Get Information Text. More...

	setAlert ($a_alert)
	Set Alert Text. More...

	getAlert ()
	Get Alert Text. More...

	setRequired ($a_required)
	Set Required. More...

	getRequired ()
	Get Required. More...

	setDisabled ($a_disabled)
	Set Disabled. More...

	getDisabled ()
	Get Disabled. More...

	checkInput ()
	Check input, strip slashes etc. More...

	setParentForm ($a_parentform)
	Set Parent Form. More...

	getParentForm ()
	Get Parent Form. More...

	setParent ($a_val)
	Set Parent GUI object. More...

	getParent ()
	Get Parent GUI object. More...

	getSubForm ()
	Get sub form html. More...

	hideSubForm ()
	Sub form hidden on init? More...

	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders) More...

	getHiddenTitle ()
	Get hidden title. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. More...

	serializeData ()
	serialize data More...

	unserializeData ($a_data)
	unserialize data More...

	writeToSession ()
	Write to session. More...

	clearFromSession ()
	Clear session value. More...

	readFromSession ()
	Read from session. More...

	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties) More...

	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi. More...

	getMulti ()
	Get Multi. More...

	setMultiValues (array $a_values)
	Set multi values. More...

	getMultiValues ()
	Get multi values. More...

	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...

	stripSlashesAddSpaceFallback ($a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...

Protected Member Functions
	geolocationAvailiable ()
	Is geolocation configured? More...

Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...

	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

Protected Attributes
	$rbacsystem

	$latitude

	$longitude

	$zoom

	$address

Protected Attributes inherited from ilFormPropertyGUI
	$ctrl

	$lng

	$type

	$title

	$postvar

	$info

	$alert

	$required = false

	$parentgui

	$parentform

	$hidden_title = ""

	$multi = false

	$multi_sortable = false

	$multi_addremove = true

	$multi_values

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...

Detailed Description

This class represents a location property in a property form.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilLocationInputGUI::__construct	(	$a_title = `""`,
		$a_postvar = `""`
	)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Definition at line 49 of file class.ilLocationInputGUI.php.

References $DIC, and ilFormPropertyGUI\setType().

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->rbacsystem = $DIC->rbac()->system();
         parent::__construct($a_title, $a_postvar);
         $this->setType("location");
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilLocationInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

Definition at line 158 of file class.ilLocationInputGUI.php.

References $_POST, ilFormPropertyGUI\$lng, ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), and ilUtil\stripSlashes().

     {
         $lng = $this->lng;
         
         $_POST[$this->getPostVar()]["latitude"] =
             ilUtil::stripSlashes($_POST[$this->getPostVar()]["latitude"]);
         $_POST[$this->getPostVar()]["longitude"] =
             ilUtil::stripSlashes($_POST[$this->getPostVar()]["longitude"]);
         if ($this->getRequired() &&
             (trim($_POST[$this->getPostVar()]["latitude"]) == "" || trim($_POST[$this->getPostVar()]["longitude"]) == "")) {
             $this->setAlert($lng->txt("msg_input_is_required"));
 
             return false;
         }
         return true;
     }

Here is the call graph for this function:

◆ geolocationAvailiable()

ilLocationInputGUI::geolocationAvailiable ( )

protected

Is geolocation configured?

Returns: bool

Definition at line 260 of file class.ilLocationInputGUI.php.

References ilMapUtil\getStdGeolocationServer(), and ilMapUtil\getType().

Referenced by insert().

     {
         include_once("./Services/Maps/classes/class.ilMapUtil.php");
         switch (ilMapUtil::getType()) {
             case 'openlayers':
                 return ilMapUtil::getStdGeolocationServer() ? true : false;
             case 'googlemaps':
                 return true;
             default:
                 return false;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAddress()

ilLocationInputGUI::getAddress ( )

Get Address.

Returns: string Address

Definition at line 136 of file class.ilLocationInputGUI.php.

References $address.

Referenced by insert().

     {
         return $this->address;
     }

Here is the caller graph for this function:

◆ getLatitude()

ilLocationInputGUI::getLatitude ( )

Get Latitude.

Returns: real Latitude

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

References $latitude.

Referenced by insert().

     {
         return $this->latitude;
     }

Here is the caller graph for this function:

◆ getLongitude()

ilLocationInputGUI::getLongitude ( )

Get Longitude.

Returns: real Longitude

Definition at line 96 of file class.ilLocationInputGUI.php.

References $longitude.

Referenced by insert().

     {
         return $this->longitude;
     }

Here is the caller graph for this function:

◆ getZoom()

ilLocationInputGUI::getZoom ( )

Get Zoom.

Returns: int Zoom

Definition at line 116 of file class.ilLocationInputGUI.php.

References $zoom.

Referenced by insert().

     {
         return $this->zoom;
     }

Here is the caller graph for this function:

◆ insert()

ilLocationInputGUI::insert ( $a_tpl )

Insert property html.

Definition at line 179 of file class.ilLocationInputGUI.php.

References $i, ilFormPropertyGUI\$lng, $rbacsystem, $tpl, array, ilUtil\formSelect(), geolocationAvailiable(), getAddress(), getLatitude(), getLongitude(), ilMapUtil\getMapGUI(), ilFormPropertyGUI\getPostVar(), and getZoom().

     {
         $lng = $this->lng;
         $rbacsystem = $this->rbacsystem;
         
         $lng->loadLanguageModule("maps");
         $tpl = new ilTemplate("tpl.prop_location.html", true, true, "Services/Form");
         $tpl->setVariable("POST_VAR", $this->getPostVar());
         $tpl->setVariable("TXT_ZOOM", $lng->txt("maps_zoom_level"));
         $tpl->setVariable("TXT_LATITUDE", $lng->txt("maps_latitude"));
         $tpl->setVariable("TXT_LONGITUDE", $lng->txt("maps_longitude"));
         $tpl->setVariable("LOC_DESCRIPTION", $lng->txt("maps_std_location_desc"));
         
         $lat = is_numeric($this->getLatitude())
             ? $this->getLatitude()
             : 0;
         $long = is_numeric($this->getLongitude())
             ? $this->getLongitude()
             : 0;
         $tpl->setVariable("PROPERTY_VALUE_LAT", $lat);
         $tpl->setVariable("PROPERTY_VALUE_LONG", $long);
         for ($i = 0; $i <= 18; $i++) {
             $levels[$i] = $i;
         }
         
         $map_id = "map_" . md5(uniqid());
         
         $tpl->setVariable(
             "ZOOM_SELECT",
             ilUtil::formSelect(
                 $this->getZoom(),
                 $this->getPostVar() . "[zoom]",
                 $levels,
                 false,
                 true,
                 0,
                 "",
                 array("id" => $map_id . "_zoom",
                 "onchange" => "ilUpdateMap('" . $map_id . "');")
             )
         );
         $tpl->setVariable("MAP_ID", $map_id);
         $tpl->setVariable("ID", $this->getPostVar());
 
         // only show address input if geolocation url available
         // else, if admin: show warning.
 
         if ($this->geolocationAvailiable()) {
             $tpl->setVariable("TXT_ADDR", $lng->txt("address"));
             $tpl->setVariable("TXT_LOOKUP", $lng->txt("maps_lookup_address"));
             $tpl->setVariable("TXT_ADDRESS", $this->getAddress());
             $tpl->setVariable("MAP_ID_ADDR", $map_id);
             $tpl->setVariable("POST_VAR_ADDR", $this->getPostVar());
         } else {
             if ($rbacsystem->checkAccess("visible", SYSTEM_FOLDER_ID)) {
                 $tpl->setVariable("TEXT", $lng->txt("configure_geolocation"));
             }
         }
 
         include_once("./Services/Maps/classes/class.ilMapUtil.php");
         $map_gui = ilMapUtil::getMapGUI();
         $map_gui->setMapId($map_id)
                 ->setLatitude($lat)
                 ->setLongitude($long)
                 ->setZoom($this->getZoom())
                 ->setEnableTypeControl(true)
                 ->setEnableLargeMapControl(true)
                 ->setEnableUpdateListener(true)
                 ->setEnableCentralMarker(true);
 
         $tpl->setVariable("MAP", $map_gui->getHtml());
         
         $a_tpl->setCurrentBlock("prop_generic");
         $a_tpl->setVariable("PROP_GENERIC", $tpl->get());
         $a_tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

◆ setAddress()

ilLocationInputGUI::setAddress ( $a_address )

Set Address.

Parameters

string $a_Address Address

Definition at line 126 of file class.ilLocationInputGUI.php.

     {
         $this->address = $a_address;
     }

◆ setLatitude()

ilLocationInputGUI::setLatitude ( $a_latitude )

Set Latitude.

Parameters

real $a_latitude Latitude

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

Referenced by ilPersonalProfileGUI\addLocationToForm(), ilObjGroupGUI\editMapSettingsObject(), ilObjCourseGUI\editMapSettingsObject(), ilObjExternalToolsSettingsGUI\editMapsObject(), and setValueByArray().

     {
         $this->latitude = $a_latitude;
     }

Here is the caller graph for this function:

◆ setLongitude()

ilLocationInputGUI::setLongitude ( $a_longitude )

Set Longitude.

Parameters

real $a_longitude Longitude

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

Referenced by ilADTLocationSearchBridgeSingle\addToForm(), and setValueByArray().

     {
         $this->longitude = $a_longitude;
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilLocationInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

Definition at line 146 of file class.ilLocationInputGUI.php.

References ilFormPropertyGUI\getPostVar(), setLatitude(), setLongitude(), and setZoom().

     {
         $this->setLatitude($a_values[$this->getPostVar()]["latitude"]);
         $this->setLongitude($a_values[$this->getPostVar()]["longitude"]);
         $this->setZoom($a_values[$this->getPostVar()]["zoom"]);
     }

Here is the call graph for this function:

◆ setZoom()

ilLocationInputGUI::setZoom ( $a_zoom )

Set Zoom.

Parameters

int $a_zoom Zoom

Definition at line 106 of file class.ilLocationInputGUI.php.

Referenced by setValueByArray().

     {
         $this->zoom = $a_zoom;
     }

Here is the caller graph for this function:

Field Documentation

◆ $address

ilLocationInputGUI::$address

protected

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

Referenced by getAddress().

◆ $latitude

ilLocationInputGUI::$latitude

protected

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

Referenced by getLatitude().

◆ $longitude

ilLocationInputGUI::$longitude

protected

Definition at line 39 of file class.ilLocationInputGUI.php.

Referenced by getLongitude().

◆ $rbacsystem

ilLocationInputGUI::$rbacsystem

protected

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

Referenced by insert().

◆ $zoom

ilLocationInputGUI::$zoom

protected

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

Referenced by getZoom().

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

Services/Form/classes/class.ilLocationInputGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ geolocationAvailiable()

◆ getAddress()

◆ getLatitude()

◆ getLongitude()

◆ getZoom()

◆ insert()

◆ setAddress()

◆ setLatitude()

◆ setLongitude()

◆ setValueByArray()

◆ setZoom()

Field Documentation

◆ $address

◆ $latitude

◆ $longitude

◆ $rbacsystem

◆ $zoom