ilADTLocationFormBridge Class Reference

Inheritance diagram for ilADTLocationFormBridge:

Collaboration diagram for ilADTLocationFormBridge:

Public Member Functions
	addToForm ()
	Add ADT-specific fields to form. More...
	importFromPost ()
	Import values from form request POST data. More...
Public Member Functions inherited from ilADTFormBridge
	__construct (ilADT $a_adt)
	getADT ()
	setForm (ilPropertyFormGUI $a_form)
	getForm ()
	setElementId (string $a_value)
	Set element id (aka form field) More...
	getElementId ()
	setTitle (string $a_value)
	getTitle ()
	setInfo (string $a_value)
	getInfo ()
	setParentElement ($a_value)
	getParentElement ()
	Get parent element. More...
	setDisabled (bool $a_value)
	isDisabled ()
	setRequired (bool $a_value)
	isRequired ()
	addToForm ()
	Add ADT-specific fields to form. More...
	addJS (ilGlobalTemplateInterface $a_tpl)
	Add ADT-specific JS-files to template. More...
	shouldBeImportedFromPost (?ilADTFormBridge $a_parent_adt=null)
	Check if incoming values should be imported at all. More...
	importFromPost ()
	Import values from form request POST data. More...
	validate ()
	setExternalErrors (array $a_errors)

Protected Member Functions
	isValidADT (ilADT $a_adt)
Protected Member Functions inherited from ilADTFormBridge
	isValidADT (ilADT $a_adt)
	setADT (ilADT $a_adt)
	addBasicFieldProperties (ilFormPropertyGUI $a_field, ilADTDefinition $a_def)
	Helper method to handle generic properties like setRequired(), setInfo() More...
	findParentElementInForm ()
	addToParentElement (ilFormPropertyGUI $a_field)
	isActiveForSubItems ($a_parent_option=null)
	Check if element is currently active for subitem(s) More...

Additional Inherited Members
Protected Attributes inherited from ilADTFormBridge
ilADT	$adt
ilPropertyFormGUI	$form
	$parent
string	$id = null
string	$title = ''
string	$info = ''
	$parent_element
bool	$required = false
bool	$disabled = false
ilLanguage	$lng

Detailed Description

Definition at line 21 of file class.ilADTLocationFormBridge.php.

Member Function Documentation

addToForm()

ilADTLocationFormBridge::addToForm

(

)

Add ADT-specific fields to form.

Reimplemented from ilADTFormBridge.

Definition at line 28 of file class.ilADTLocationFormBridge.php.

                               : void
    {
        $adt = $this->getADT();
 
        $default = false;
        if ($adt->isNull()) {
            // see ilPersonalProfileGUI::addLocationToForm()
            // use installation default
            $def = ilMapUtil::getDefaultSettings();
            $adt->setLatitude((float) $def["latitude"]);
            $adt->setLongitude((float) $def["longitude"]);
            $adt->setZoom((int) $def["zoom"]);
 
            $default = true;
        }
 
        // :TODO: title?
        $title = $this->isRequired()
            ? $this->getTitle()
            : $this->lng->txt("location");
 
        $loc = new ilLocationInputGUI($title, $this->getElementId());
        $loc->setLongitude($adt->getLongitude());
        $loc->setLatitude($adt->getLatitude());
        $loc->setZoom($adt->getZoom());
 
        $this->addBasicFieldProperties($loc, $adt->getCopyOfDefinition());
 
        if (!$this->isRequired()) {
            $optional = new ilCheckboxInputGUI($this->getTitle(), $this->getElementId() . "_tgl");
            $optional->addSubItem($loc);
            $this->addToParentElement($optional);
 
            if (!$default && !$adt->isNull()) {
                $optional->setChecked(true);
            }
        } else {
            $this->addToParentElement($loc);
        }
    }

References ilADTFormBridge\$adt, ilADTFormBridge\$title, ilADTFormBridge\addBasicFieldProperties(), ilADTFormBridge\addToParentElement(), ilADTFormBridge\getADT(), ilADT\getCopyOfDefinition(), ilMapUtil\getDefaultSettings(), ilADTFormBridge\getElementId(), ilADTFormBridge\getTitle(), ilADT\isNull(), ilADTFormBridge\isRequired(), and ILIAS\Repository\lng().

Here is the call graph for this function:

importFromPost()

ilADTLocationFormBridge::importFromPost

(

)

Import values from form request POST data.

Reimplemented from ilADTFormBridge.

Definition at line 69 of file class.ilADTLocationFormBridge.php.

                                    : void
    {
        $do_import = true;
        if (!$this->isRequired()) {
            $toggle = $this->getForm()->getInput($this->getElementId() . "_tgl");
            if (!$toggle) {
                $do_import = false;
            }
        }
 
        if ($do_import) {
            // ilPropertyFormGUI::checkInput() is pre-requisite
            $incoming = $this->getForm()->getInput($this->getElementId());
            $this->getADT()->setLongitude((float) $incoming["longitude"]);
            $this->getADT()->setLatitude((float) $incoming["latitude"]);
            $this->getADT()->setZoom((int) $incoming["zoom"]);
        } else {
            $this->getADT()->setLongitude(null);
            $this->getADT()->setLatitude(null);
            $this->getADT()->setZoom(null);
        }
 
        $field = $this->getForm()->getItemByPostVar($this->getElementId());
        $field->setLongitude($this->getADT()->getLongitude());
        $field->setLatitude($this->getADT()->getLatitude());
        $field->setZoom($this->getADT()->getZoom());
    }

References ilADTFormBridge\getADT(), ilADTFormBridge\getElementId(), ilADTFormBridge\getForm(), and ilADTFormBridge\isRequired().

Here is the call graph for this function:

isValidADT()

ilADTLocationFormBridge::isValidADT ( ilADT  $a_adt )

protected

Reimplemented from ilADTFormBridge.

Definition at line 23 of file class.ilADTLocationFormBridge.php.

                                               : bool
    {
        return ($a_adt instanceof ilADTLocation);
    }

---

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

• components/ILIAS/ADT/classes/Types/Location/class.ilADTLocationFormBridge.php