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)
	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...
	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)
	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...

Protected Attributes
	$force_radio
	$option_infos = []
	$auto_sort = true
Protected Attributes inherited from ilADTFormBridge
	$adt
	$form
	$id
	$title
	$info
	$parent_element
	$required
	$disabled

Detailed Description

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

Member Function Documentation

addToForm()

ilADTEnumFormBridge::addToForm

(

)

Add ADT-specific fields to form.

Reimplemented from ilADTFormBridge.

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

    {
        global $DIC;
 
        $lng = $DIC['lng'];
                
        $def = $this->getADT()->getCopyOfDefinition();
        $selection = $this->getADT()->getSelection();
        
        $options = $def->getOptions();
        
        if ((bool) $this->auto_sort) {
            asort($options);
        }
        
        if (!$this->isRequired()) {
            $options = array("" => "-") + $options;
        } elseif ($this->getADT()->isNull()) {
            $options = array("" => $lng->txt("please_select")) + $options;
        }
 
        if (!(bool) $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 $def, $DIC, $lng, $options, ilADTFormBridge\addBasicFieldProperties(), ilADTFormBridge\addToParentElement(), ilADTFormBridge\getADT(), ilADTFormBridge\getElementId(), ilADTFormBridge\getTitle(), and ilADTFormBridge\isRequired().

Here is the call graph for this function:

forceRadio()

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

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

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

importFromPost()

ilADTEnumFormBridge::importFromPost

(

)

Import values from form request POST data.

Reimplemented from ilADTFormBridge.

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

    {
        // 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

$a_parent_option

Returns

bool

Reimplemented from ilADTFormBridge.

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

    {
        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

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

    {
        return ($a_adt instanceof ilADTEnum);
    }

setAutoSort()

ilADTEnumFormBridge::setAutoSort

(

$a_value

)

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

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

Field Documentation

$auto_sort

ilADTEnumFormBridge::$auto_sort = true

protected

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

$force_radio

ilADTEnumFormBridge::$force_radio

protected

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

$option_infos

ilADTEnumFormBridge::$option_infos = []

protected

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

---

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

• Services/ADT/classes/Types/Enum/class.ilADTEnumFormBridge.php