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)
	Constructor. More...
	getADT ()
	Get ADT. More...
	setForm (ilPropertyFormGUI $a_form)
	Set form. More...
	getForm ()
	Get form. More...
	setElementId ($a_value)
	Set element id (aka form field) More...
	getElementId ()
	Get element id. More...
	setTitle ($a_value)
	Set title (aka form field caption) More...
	getTitle ()
	Get title. More...
	setInfo ($a_value)
	Set info (aka form field info text) More...
	getInfo ()
	Get info. More...
	setParentElement ($a_value)
	Set parent element. More...
	getParentElement ()
	Get parent element. More...
	setDisabled ($a_value)
	Set disabled. More...
	isDisabled ()
	Get disabled. More...
	setRequired ($a_value)
	Set required. More...
	isRequired ()
	Get required. More...
	addToForm ()
	Add ADT-specific fields to form. More...
	addJS (ilTemplate $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 ()
	Validate ADT and parse error codes. More...
	setExternalErrors ($a_errors)

Protected Member Functions
	isValidADT (ilADT $a_adt)
	Check if given ADT is valid. More...
Protected Member Functions inherited from ilADTFormBridge
	isValidADT (ilADT $a_adt)
	Check if given ADT is valid. More...
	setADT (ilADT $a_adt)
	Set ADT. More...
	addBasicFieldProperties (ilFormPropertyGUI $a_field, ilADTDefinition $a_def)
	Helper method to handle generic properties like setRequired(), setInfo() More...
	findParentElementInForm ()
	Try to find parent element in form (could be option) More...
	addToParentElement (ilFormPropertyGUI $a_field)
	Add form field to parent element. More...
	isActiveForSubItems ($a_parent_option=null)
	Check if element is currently active for subitem(s) More...

Additional Inherited Members
Protected Attributes inherited from ilADTFormBridge
	$adt
	$form
	$id
	$title
	$info
	$parent_element
	$required
	$disabled

Detailed Description

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

Member Function Documentation

addToForm()

ilADTLocationFormBridge::addToForm

(

)

Add ADT-specific fields to form.

Reimplemented from ilADTFormBridge.

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

    {
        global $DIC;
 
        $lng = $DIC['lng'];
        
        $adt = $this->getADT();
        
        $default = false;
        if ($adt->isNull()) {
            // see ilPersonalProfileGUI::addLocationToForm()
            
            // use installation default
            include_once("./Services/Maps/classes/class.ilMapUtil.php");
            $def = ilMapUtil::getDefaultSettings();
            $adt->setLatitude($def["latitude"]);
            $adt->setLongitude($def["longitude"]);
            $adt->setZoom($def["zoom"]);
            
            $default = true;
        }
        
        // :TODO: title?
        $title = $this->isRequired()
            ? $this->getTitle()
            : $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, $def, $default, $DIC, $lng, ilADTFormBridge\$title, ilADTFormBridge\addBasicFieldProperties(), ilADTFormBridge\addToParentElement(), ilADTFormBridge\getADT(), ilMapUtil\getDefaultSettings(), ilADTFormBridge\getElementId(), ilADTFormBridge\getTitle(), and ilADTFormBridge\isRequired().

Here is the call graph for this function:

importFromPost()

ilADTLocationFormBridge::importFromPost

(

)

Import values from form request POST data.

Reimplemented from ilADTFormBridge.

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

    {
        $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($incoming["longitude"]);
            $this->getADT()->setLatitude($incoming["latitude"]);
            $this->getADT()->setZoom($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

Check if given ADT is valid.

:TODO: This could be avoided with type-specifc constructors :TODO: bridge base class?

Parameters

ilADT

$a_adt

Reimplemented from ilADTFormBridge.

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

    {
        return ($a_adt instanceof ilADTLocation);
    }

---

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

• Services/ADT/classes/Types/Location/class.ilADTLocationFormBridge.php