ilLocationInputGUI Class Reference

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

Inheritance diagram for ilLocationInputGUI:

Collaboration diagram for ilLocationInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")
	setLatitude (?float $a_latitude)
	getLatitude ()
	setLongitude (?float $a_longitude)
	getLongitude ()
	setZoom (?int $a_zoom)
	getZoom ()
	setAddress (string $a_address)
	getAddress ()
	setValueByArray (array $a_values)
	checkInput ()
	getInput ()
	insert (ilTemplate $a_tpl)
Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")
	executeCommand ()
	getType ()
	setTitle (string $a_title)
	getTitle ()
	setPostVar (string $a_postvar)
	getPostVar ()
	getFieldId ()
	setInfo (string $a_info)
	getInfo ()
	setAlert (string $a_alert)
	getAlert ()
	setRequired (bool $a_required)
	getRequired ()
	setDisabled (bool $a_disabled)
	getDisabled ()
	checkInput ()
	Check input, strip slashes etc. More...
	setParentForm (ilPropertyFormGUI $a_parentform)
	getParentForm ()
	setParent (ilFormPropertyGUI $a_val)
	getParent ()
	getSubForm ()
	hideSubForm ()
	setHiddenTitle (string $a_val)
	getHiddenTitle ()
	getItemByPostVar (string $a_post_var)
	Get item by post var. More...
	serializeData ()
	unserializeData (string $a_data)
	setParentTable ($a_val)
	Set parent table. More...
	getParentTable ()
	Get parent table. More...
	writeToSession ()
	clearFromSession ()
	readFromSession ()
	getHiddenTag (string $a_post_var, string $a_value)
	setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)
	getMulti ()
	setMultiValues (array $a_values)
	getMultiValues ()
	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...
	stripSlashesAddSpaceFallback (string $a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...
	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...
	getFormLabelFor ()
	Get label "for" attribute value for form. More...
	setRequestParam (string $key, $val)
	This writes the request (aka post) values. More...

Protected Member Functions
	geolocationAvailiable ()
Protected Member Functions inherited from ilFormPropertyGUI
	symbol ()
	setType (string $a_type)
	checkParentFormTable ()
	getSessionKey ()
	getMultiIconsHTML ()
	int ($key)
	intArray ($key)
	str ($key)
	raw ($key)
	strArray ($key)
	arrayArray ($key)
	isRequestParamArray (string $key)
	getRequestParam (string $key, Refinery\Transformation $t)

Protected Attributes
ilRbacSystem	$rbacsystem
float	$latitude = null
float	$longitude = null
int	$zoom = null
string	$address = ""
Protected Attributes inherited from ilFormPropertyGUI
array	$set_params = []
ilTable2GUI	$parent_table = null
ilFormPropertyGUI	$parent_gui = null
ilCtrl	$ctrl
ilLanguage	$lng
string	$type = ""
string	$title = ""
string	$postvar = ""
string	$info = ""
string	$alert = ""
bool	$required = false
ilPropertyFormGUI	$parentform = null
string	$hidden_title = ""
bool	$multi = false
bool	$multi_sortable = false
bool	$multi_addremove = true
array	$multi_values = []
RequestInterface	$request
HTTP Services	$http
Refinery Factory	$refinery = null
bool	$disabled = false
ilGlobalTemplateInterface	$global_tpl = null

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

Detailed Description

This class represents a location property in a property form.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Deprecated:

12 This component will be removed with ILIAS 12

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

Constructor & Destructor Documentation

__construct()

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

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), 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

(

)

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

References ilFormPropertyGUI\$lng, ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), ilFormPropertyGUI\strArray(), and ilLanguage\txt().

                                : bool
    {
        $lng = $this->lng;

        $val = $this->strArray($this->getPostVar());
        if ($this->getRequired() && (
            !isset($val["latitude"]) || trim($val["latitude"]) == "" ||
            !isset($val["longitude"]) || trim($val["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

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

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

Referenced by insert().

                                              : bool
    {
        switch (ilMapUtil::getType()) {
            case 'openlayers':
                return (bool) ilMapUtil::getStdGeolocationServer();
            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

(

)

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

References $address.

Referenced by insert().

                                : string
    {
        return $this->address;
    }

Here is the caller graph for this function:

getInput()

ilLocationInputGUI::getInput

(

)

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

References ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\int(), and ilFormPropertyGUI\strArray().

                              : array
    {
        $val = $this->strArray($this->getPostVar());
        return [
            "latitude" => (float) ($val["latitude"] ?? 0),
            "longitude" => (float) ($val["longitude"] ?? 0),
            "zoom" => (int) ($val["zoom"] ?? 0),
            "address" => ($val["address"] ?? "")
        ];
    }

Here is the call graph for this function:

getLatitude()

ilLocationInputGUI::getLatitude

(

)

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

References $latitude.

Referenced by insert().

                                 : ?float
    {
        return $this->latitude;
    }

Here is the caller graph for this function:

getLongitude()

ilLocationInputGUI::getLongitude

(

)

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

References $longitude.

Referenced by insert().

                                  : ?float
    {
        return $this->longitude;
    }

Here is the caller graph for this function:

getZoom()

ilLocationInputGUI::getZoom

(

)

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

References $zoom.

Referenced by insert().

                             : ?int
    {
        return $this->zoom;
    }

Here is the caller graph for this function:

insert()

ilLocationInputGUI::insert

(

ilTemplate

$a_tpl

)

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

References ilFormPropertyGUI\$lng, $rbacsystem, ilRbacSystem\checkAccess(), ilLegacyFormElementsUtil\formSelect(), geolocationAvailiable(), getAddress(), getLatitude(), getLongitude(), ilMapUtil\getMapGUI(), ilFormPropertyGUI\getPostVar(), getZoom(), ilLanguage\loadLanguageModule(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), SYSTEM_FOLDER_ID, and ilLanguage\txt().

                                             : void
    {
        $lng = $this->lng;
        $rbacsystem = $this->rbacsystem;
        $levels = [];

        $lng->loadLanguageModule("maps");
        $tpl = new ilTemplate("tpl.prop_location.html", true, true, "components/ILIAS/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",
            ilLegacyFormElementsUtil::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"));
            }
        }

        $map_gui = ilMapUtil::getMapGUI();
        $map_gui->setMapId($map_id)
                ->setLatitude((string) $lat)
                ->setLongitude((string) $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

(

string

$a_address

)

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

                                                 : void
    {
        $this->address = $a_address;
    }

setLatitude()

ilLocationInputGUI::setLatitude

(

?float

$a_latitude

)

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

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

                                                   : void
    {
        $this->latitude = $a_latitude;
    }

Here is the caller graph for this function:

setLongitude()

ilLocationInputGUI::setLongitude

(

?float

$a_longitude

)

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

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

                                                     : void
    {
        $this->longitude = $a_longitude;
    }

Here is the caller graph for this function:

setValueByArray()

ilLocationInputGUI::setValueByArray

(

array

$a_values

)

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

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

                                                    : void
    {
        $lat = (isset($a_values[$this->getPostVar()]["latitude"]) && $a_values[$this->getPostVar()]["latitude"] != "")
            ? (float) $a_values[$this->getPostVar()]["latitude"]
            : null;
        $lon = (isset($a_values[$this->getPostVar()]["longitude"]) && $a_values[$this->getPostVar()]["longitude"] != "")
            ? (float) $a_values[$this->getPostVar()]["longitude"]
            : null;
        $this->setLatitude($lat);
        $this->setLongitude($lon);
        $this->setZoom((int) $a_values[$this->getPostVar()]["zoom"]);
    }

Here is the call graph for this function:

setZoom()

ilLocationInputGUI::setZoom

(

?int

$a_zoom

)

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

Referenced by setValueByArray().

                                         : void
    {
        $this->zoom = $a_zoom;
    }

Here is the caller graph for this function:

Field Documentation

$address

string ilLocationInputGUI::$address = ""

protected

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

Referenced by getAddress().

$latitude

float ilLocationInputGUI::$latitude = null

protected

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

Referenced by getLatitude().

$longitude

float ilLocationInputGUI::$longitude = null

protected

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

Referenced by getLongitude().

$rbacsystem

ilRbacSystem ilLocationInputGUI::$rbacsystem

protected

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

Referenced by insert().

$zoom

int ilLocationInputGUI::$zoom = null

protected

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

Referenced by getZoom().

---

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

• components/ILIAS/Form/classes/class.ilLocationInputGUI.php