ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilADTBooleanFormBridge Class Reference
+ Inheritance diagram for ilADTBooleanFormBridge:
+ Collaboration diagram for ilADTBooleanFormBridge:

Public Member Functions

 addToForm ()
 Add ADT-specific fields to form. More...
 
 importFromPost ()
 Import values from form request POST data. More...
 
 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)
 Check if element is currently active for subitem(s) More...
 
- 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.ilADTBooleanFormBridge.php.

Member Function Documentation

◆ addToForm()

ilADTBooleanFormBridge::addToForm ( )

Add ADT-specific fields to form.

Reimplemented from ilADTFormBridge.

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

28 : void
29 {
30 $bool = new ilCheckboxInputGUI($this->getTitle(), $this->getElementId());
31 $bool->setValue('1');
32 $this->addBasicFieldProperties($bool, $this->getADT()->getCopyOfDefinition());
33 $bool->setRequired(false);
34 $bool->setChecked($this->getADT()->getStatus());
35 $this->addToParentElement($bool);
36 }
addBasicFieldProperties(ilFormPropertyGUI $a_field, ilADTDefinition $a_def)
Helper method to handle generic properties like setRequired(), setInfo()
addToParentElement(ilFormPropertyGUI $a_field)
This class represents a checkbox property in a property form.

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

+ Here is the call graph for this function:

◆ importFromPost()

ilADTBooleanFormBridge::importFromPost ( )

Import values from form request POST data.

Reimplemented from ilADTFormBridge.

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

38 : void
39 {
40 // ilPropertyFormGUI::checkInput() is pre-requisite
41 $incoming = $this->getForm()->getInput($this->getElementId());
42
43 // unchecked == no incoming
44 $incoming = (bool) $incoming;
45
46 $this->getADT()->setStatus($incoming);
47
48 $field = $this->getForm()->getItemByPostVar($this->getElementId());
49 $field->setChecked($this->getADT()->getStatus());
50 }

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

+ Here is the call graph for this function:

◆ isActiveForSubItems()

ilADTBooleanFormBridge::isActiveForSubItems (   $a_parent_option = null)
protected

Check if element is currently active for subitem(s)

Parameters
mixed | null$a_parent_option
Returns
bool

Reimplemented from ilADTFormBridge.

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

57 : bool
58 {
59 return ($this->getADT()->getStatus() === true);
60 }

References ilADTFormBridge\getADT().

+ Here is the call graph for this function:

◆ isValidADT()

ilADTBooleanFormBridge::isValidADT ( ilADT  $a_adt)
protected

Reimplemented from ilADTFormBridge.

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

23 : bool
24 {
25 return ($a_adt instanceof ilADTBoolean);
26 }

◆ validate()

ilADTBooleanFormBridge::validate ( )

Reimplemented from ilADTFormBridge.

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

52 : bool
53 {
54 return true;
55 }

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