ilADTEnumFormBridge Class Reference

Inheritance diagram for ilADTEnumFormBridge:

Collaboration diagram for ilADTEnumFormBridge:

Public Member Functions
	setAutoSort ($a_value)
	forceRadio ($a_value, ?array $a_info=null)
	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)
	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...

Protected Attributes
bool	$force_radio = false
array	$option_infos = []
bool	$auto_sort = true
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.ilADTEnumFormBridge.php.

Member Function Documentation

addToForm()

ilADTEnumFormBridge::addToForm

(

)

Add ADT-specific fields to form.

Reimplemented from ilADTFormBridge.

Definition at line 45 of file class.ilADTEnumFormBridge.php.

                               : void
    {
        $def = $this->getADT()->getCopyOfDefinition();
        $selection = $this->getADT()->getSelection();
 
        $options = $def->getOptions();
 
        if ($this->auto_sort) {
            asort($options);
        }
 
        if (!$this->isRequired()) {
            $options = array("" => "-") + $options;
        } elseif ($this->getADT()->isNull()) {
            $options = array("" => $this->lng->txt("please_select")) + $options;
        }
 
        if (!$this->force_radio) {
            $select = new ilSelectInputGUI($this->getTitle(), $this->getElementId());
 
            $select->setOptions($options);
        } else {
            $select = new ilRadioGroupInputGUI($this->getTitle(), $this->getElementId());
 
            foreach ($options as $value => $caption) {
                $option = new ilRadioOption($caption, $value);
                if (is_array($this->option_infos) && array_key_exists($value, $this->option_infos)) {
                    $option->setInfo($this->option_infos[$value]);
                }
                $select->addOption($option);
            }
        }
 
        $this->addBasicFieldProperties($select, $def);
 
        $select->setValue($selection);
 
        $this->addToParentElement($select);
    }

References ilADTFormBridge\addBasicFieldProperties(), ilADTFormBridge\addToParentElement(), ilADTFormBridge\getADT(), ilADTFormBridge\getElementId(), ilADTFormBridge\getTitle(), ilADTFormBridge\isRequired(), and ILIAS\Repository\lng().

Here is the call graph for this function:

forceRadio()

ilADTEnumFormBridge::forceRadio	(		$a_value,
		?array	$a_info = null
	)

Definition at line 37 of file class.ilADTEnumFormBridge.php.

    {
        $this->force_radio = (bool) $a_value;
        if ($this->force_radio) {
            $this->option_infos = (array) $a_info;
        }
    }

importFromPost()

ilADTEnumFormBridge::importFromPost

(

)

Import values from form request POST data.

Reimplemented from ilADTFormBridge.

Definition at line 85 of file class.ilADTEnumFormBridge.php.

                                    : void
    {
        // ilPropertyFormGUI::checkInput() is pre-requisite
        $this->getADT()->setSelection($this->getForm()->getInput($this->getElementId()));
 
        $field = $this->getForm()->getItemByPostVar($this->getElementId());
        $field->setValue($this->getADT()->getSelection());
    }

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

Here is the call graph for this function:

isActiveForSubItems()

ilADTEnumFormBridge::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 94 of file class.ilADTEnumFormBridge.php.

                                                                   : bool
    {
        return ($this->getADT()->getSelection() == $a_parent_option);
    }

References ilADTFormBridge\getADT().

Here is the call graph for this function:

isValidADT()

ilADTEnumFormBridge::isValidADT ( ilADT  $a_adt )

protected

Reimplemented from ilADTFormBridge.

Definition at line 27 of file class.ilADTEnumFormBridge.php.

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

setAutoSort()

ilADTEnumFormBridge::setAutoSort

(

$a_value

)

Definition at line 32 of file class.ilADTEnumFormBridge.php.

    {
        $this->auto_sort = (bool) $a_value;
    }

Field Documentation

$auto_sort

bool ilADTEnumFormBridge::$auto_sort = true

protected

Definition at line 25 of file class.ilADTEnumFormBridge.php.

$force_radio

bool ilADTEnumFormBridge::$force_radio = false

protected

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

$option_infos

array ilADTEnumFormBridge::$option_infos = []

protected

Definition at line 24 of file class.ilADTEnumFormBridge.php.

---

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

• components/ILIAS/ADT/classes/Types/Enum/class.ilADTEnumFormBridge.php