ilADTMultiEnumFormBridge Class Reference

Inheritance diagram for ilADTMultiEnumFormBridge:

Collaboration diagram for ilADTMultiEnumFormBridge:

Public Member Functions
	setOptionInfos (array $a_info=null)
	setAutoSort (bool $a_value)
	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
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 5 of file class.ilADTMultiEnumFormBridge.php.

Member Function Documentation

addToForm()

ilADTMultiEnumFormBridge::addToForm

(

)

Add ADT-specific fields to form.

Reimplemented from ilADTFormBridge.

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

                               : void
    {
        $def = $this->getADT()->getCopyOfDefinition();
        $options = $def->getOptions();
 
        if ($this->auto_sort) {
            asort($options);
        }
 
        $cbox = new ilCheckboxGroupInputGUI($this->getTitle(), $this->getElementId());
 
        foreach ($options as $value => $caption) {
            $option = new ilCheckboxOption($caption, (string) $value);
            if (is_array($this->option_infos) && array_key_exists($value, $this->option_infos)) {
                $option->setInfo($this->option_infos[$value]);
            }
            $cbox->addOption($option);
        }
 
        $this->addBasicFieldProperties($cbox, $def);
 
        $cbox->setValue($this->getADT()->getSelections());
 
        $this->addToParentElement($cbox);
    }

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

Here is the call graph for this function:

importFromPost()

ilADTMultiEnumFormBridge::importFromPost

(

)

Import values from form request POST data.

Reimplemented from ilADTFormBridge.

Definition at line 51 of file class.ilADTMultiEnumFormBridge.php.

                                    : void
    {
        // ilPropertyFormGUI::checkInput() is pre-requisite
 
        /*
         * BT 32161: post value is null when no checkbox is selected,
         * check whether the corresponding form input really exists, just
         * to be sure.
         */
        if (is_object($this->getForm()->getItemByPostVar($this->getElementId()))) {
            $this->getADT()->setSelections($this->getForm()->getInput($this->getElementId()) ?? []);
        }
 
        $field = $this->getForm()->getItemByPostVar($this->getElementId());
        $field->setValue($this->getADT()->getSelections());
    }

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

Here is the call graph for this function:

isActiveForSubItems()

ilADTMultiEnumFormBridge::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 68 of file class.ilADTMultiEnumFormBridge.php.

                                                                   : bool
    {
        $current = $this->getADT()->getSelections();
        return (is_array($current) && in_array($a_parent_option, $current));
    }

References ilADTFormBridge\getADT().

Here is the call graph for this function:

isValidADT()

ilADTMultiEnumFormBridge::isValidADT ( ilADT  $a_adt )

protected

Reimplemented from ilADTFormBridge.

Definition at line 10 of file class.ilADTMultiEnumFormBridge.php.

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

setAutoSort()

ilADTMultiEnumFormBridge::setAutoSort

(

bool

$a_value

)

Definition at line 20 of file class.ilADTMultiEnumFormBridge.php.

                                              : void
    {
        $this->auto_sort = $a_value;
    }

setOptionInfos()

ilADTMultiEnumFormBridge::setOptionInfos

(

array

$a_info = null

)

Definition at line 15 of file class.ilADTMultiEnumFormBridge.php.

                                                        : void
    {
        $this->option_infos = $a_info;
    }

Field Documentation

$auto_sort

bool ilADTMultiEnumFormBridge::$auto_sort = true

protected

Definition at line 8 of file class.ilADTMultiEnumFormBridge.php.

$option_infos

array ilADTMultiEnumFormBridge::$option_infos = []

protected

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

---

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

• Services/ADT/classes/Types/MultiEnum/class.ilADTMultiEnumFormBridge.php