ILIAS  release_8 Revision v8.23
ilADTBooleanFormBridge Class Reference
+ Inheritance diagram for ilADTBooleanFormBridge:
+ Collaboration diagram for ilADTBooleanFormBridge:

Public Member Functions

 addToForm ()
 
 importFromPost ()
 
 validate ()
 
- 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)
 
 isActiveForSubItems ($a_parent_option=null)
 
- 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 5 of file class.ilADTBooleanFormBridge.php.

Member Function Documentation

◆ addToForm()

ilADTBooleanFormBridge::addToForm ( )

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

References ilADTFormBridge\addBasicFieldProperties(), ilADTFormBridge\addToParentElement(), ilADTFormBridge\getADT(), ilADTFormBridge\getElementId(), and ilADTFormBridge\getTitle().

12  : void
13  {
14  $bool = new ilCheckboxInputGUI($this->getTitle(), $this->getElementId());
15  $bool->setValue('1');
16  $this->addBasicFieldProperties($bool, $this->getADT()->getCopyOfDefinition());
17  $bool->setRequired(false);
18  $bool->setChecked($this->getADT()->getStatus());
19  $this->addToParentElement($bool);
20  }
addToParentElement(ilFormPropertyGUI $a_field)
This class represents a checkbox property in a property form.
addBasicFieldProperties(ilFormPropertyGUI $a_field, ilADTDefinition $a_def)
Helper method to handle generic properties like setRequired(), setInfo()
+ Here is the call graph for this function:

◆ importFromPost()

ilADTBooleanFormBridge::importFromPost ( )

Definition at line 22 of file class.ilADTBooleanFormBridge.php.

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

22  : void
23  {
24  // ilPropertyFormGUI::checkInput() is pre-requisite
25  $incoming = $this->getForm()->getInput($this->getElementId());
26 
27  // unchecked == no incoming
28  $incoming = (bool) $incoming;
29 
30  $this->getADT()->setStatus($incoming);
31 
32  $field = $this->getForm()->getItemByPostVar($this->getElementId());
33  $field->setChecked($this->getADT()->getStatus());
34  }
+ Here is the call graph for this function:

◆ isActiveForSubItems()

ilADTBooleanFormBridge::isActiveForSubItems (   $a_parent_option = null)
protected

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

References ilADTFormBridge\getADT().

41  : bool
42  {
43  return ($this->getADT()->getStatus() === true);
44  }
+ Here is the call graph for this function:

◆ isValidADT()

ilADTBooleanFormBridge::isValidADT ( ilADT  $a_adt)
protected

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

7  : bool
8  {
9  return ($a_adt instanceof ilADTBoolean);
10  }

◆ validate()

ilADTBooleanFormBridge::validate ( )

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

36  : bool
37  {
38  return true;
39  }

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