ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
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.

13 {
14 global $lng;
15
16 $adt = $this->getADT();
17
18 $default = false;
19 if($adt->isNull())
20 {
21 // see ilPersonalProfileGUI::addLocationToForm()
22
23 // use installation default
24 include_once("./Services/Maps/classes/class.ilMapUtil.php");
26 $adt->setLatitude($def["latitude"]);
27 $adt->setLongitude($def["longitude"]);
28 $adt->setZoom($def["zoom"]);
29
30 $default = true;
31 }
32
33 // :TODO: title?
34 $title = $this->isRequired()
35 ? $this->getTitle()
36 : $lng->txt("location");
37
38 $loc = new ilLocationInputGUI($title, $this->getElementId());
39 $loc->setLongitude($adt->getLongitude());
40 $loc->setLatitude($adt->getLatitude());
41 $loc->setZoom($adt->getZoom());
42
43 $this->addBasicFieldProperties($loc, $adt->getCopyOfDefinition());
44
45 if(!$this->isRequired())
46 {
47 $optional = new ilCheckboxInputGUI($this->getTitle(), $this->getElementId()."_tgl");
48 $optional->addSubItem($loc);
49 $this->addToParentElement($optional);
50
51 if(!$default && !$adt->isNull())
52 {
53 $optional->setChecked(true);
54 }
55 }
56 else
57 {
58 $this->addToParentElement($loc);
59 }
60 }
addBasicFieldProperties(ilFormPropertyGUI $a_field, ilADTDefinition $a_def)
Helper method to handle generic properties like setRequired(), setInfo()
getElementId()
Get element id.
addToParentElement(ilFormPropertyGUI $a_field)
Add form field to parent element.
isRequired()
Get required.
This class represents a checkbox property in a property form.
This class represents a location property in a property form.
static getDefaultSettings()
Get default longitude, latitude and zoom.
global $lng
Definition: privfeed.php:40

References ilADTFormBridge\$adt, $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 62 of file class.ilADTLocationFormBridge.php.

63 {
64 $do_import = true;
65 if(!$this->isRequired())
66 {
67 $toggle = $this->getForm()->getInput($this->getElementId()."_tgl");
68 if(!$toggle)
69 {
70 $do_import = false;
71 }
72 }
73
74 if($do_import)
75 {
76 // ilPropertyFormGUI::checkInput() is pre-requisite
77 $incoming = $this->getForm()->getInput($this->getElementId());
78 $this->getADT()->setLongitude($incoming["longitude"]);
79 $this->getADT()->setLatitude($incoming["latitude"]);
80 $this->getADT()->setZoom($incoming["zoom"]);
81 }
82 else
83 {
84 $this->getADT()->setLongitude(null);
85 $this->getADT()->setLatitude(null);
86 $this->getADT()->setZoom(null);
87 }
88
89 $field = $this->getForm()->getItemByPostvar($this->getElementId());
90 $field->setLongitude($this->getADT()->getLongitude());
91 $field->setLatitude($this->getADT()->getLatitude());
92 $field->setZoom($this->getADT()->getZoom());
93 }

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.

8 {
9 return ($a_adt instanceof ilADTLocation);
10 }

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