Inheritance diagram for ilADTGroupFormBridge:

Collaboration diagram for ilADTGroupFormBridge:

Public Member Functions
	getElements ()

	getElement ($a_name)

	addToForm ()
	Add ADT-specific fields to form. More...

	addJS (ilGlobalTemplate $a_tpl)
	Add ADT-specific JS-files to template. More...

	importFromPost ()
	Import values from form request POST data. More...

	validate ()
	Validate ADT and parse error codes. 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 (ilGlobalTemplate $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...

	prepareElements ()

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
	$elements = []

Protected Attributes inherited from ilADTFormBridge
	$adt

	$form

	$id

	$title

	$info

	$parent_element

	$required

	$disabled

Detailed Description

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

Member Function Documentation

◆ addJS()

ilADTGroupFormBridge::addJS ( ilGlobalTemplate $a_tpl )

Add ADT-specific JS-files to template.

Parameters

ilGlobalTemplate $a_tpl

Reimplemented from ilADTFormBridge.

Definition at line 65 of file class.ilADTGroupFormBridge.php.

    {
        $this->prepareElements();
        foreach ($this->elements as $element) {
            $element->addJS($a_tpl);
        }
    }

References prepareElements().

Here is the call graph for this function:

◆ addToForm()

ilADTGroupFormBridge::addToForm ( )

Add ADT-specific fields to form.

Reimplemented from ilADTFormBridge.

Definition at line 46 of file class.ilADTGroupFormBridge.php.

    {
        if ($this->getTitle()) {
            $section = new ilFormSectionHeaderGUI();
            $section->setTitle($this->getTitle());
            
            if ($this->getInfo()) {
                $section->setInfo($this->getInfo());
            }
            
            $this->getForm()->addItem($section);
        }
        
        $this->prepareElements();
        foreach ($this->elements as $element) {
            $element->addToForm();
        }
    }

References $section, ilADTFormBridge\getForm(), ilADTFormBridge\getInfo(), ilADTFormBridge\getTitle(), and prepareElements().

Here is the call graph for this function:

◆ getElement()

ilADTGroupFormBridge::getElement ( $a_name )

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

    {
        $this->prepareElements();
        if (array_key_exists($a_name, $this->elements)) {
            return $this->elements[$a_name];
        }
    }

References prepareElements().

Referenced by ilADTTestGUI\prepareFormElements().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getElements()

ilADTGroupFormBridge::getElements ( )

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

    {
        $this->prepareElements();
        return $this->elements;
    }

References $elements, and prepareElements().

Referenced by prepareElements(), ilADTTestGUI\prepareFormElements(), and validate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importFromPost()

ilADTGroupFormBridge::importFromPost ( )

Import values from form request POST data.

Reimplemented from ilADTFormBridge.

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

    {
        $this->prepareElements();
        foreach ($this->elements as $element) {
            // parse parent element
            $parent = $element->getParentElement();
            if ($parent) {
                if (is_array($parent)) {
                    $parent = $parent[0];
                }
                if (isset($adt_forms[$parent])) {
                    $parent = $adt_forms[$parent];
                } else {
                    $parent = null;
                }
            }
            if ($element->shouldBeImportedFromPost($parent)) {
                $element->importFromPost();
            }
        }
    }

References prepareElements().

Here is the call graph for this function:

◆ isValidADT()

ilADTGroupFormBridge::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 9 of file class.ilADTGroupFormBridge.php.

    {
        return ($a_adt instanceof ilADTGroup);
    }

◆ prepareElements()

ilADTGroupFormBridge::prepareElements ( )

protected

Definition at line 14 of file class.ilADTGroupFormBridge.php.

    {
        if (sizeof($this->elements)) {
            return;
        }
        
        $this->elements = array();
        $factory = ilADTFactory::getInstance();
        
        // convert ADTs to form bridges
        
        foreach ($this->getADT()->getElements() as $name => $element) {
            $this->elements[$name] = $factory->getFormBridgeForInstance($element);
            $this->elements[$name]->setForm($this->getForm());
            $this->elements[$name]->setElementId($name);
        }
    }

References $factory, $name, ilADTFormBridge\getADT(), getElements(), ilADTFormBridge\getForm(), and ilADTFactory\getInstance().

Referenced by addJS(), addToForm(), getElement(), getElements(), and importFromPost().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validate()

ilADTGroupFormBridge::validate ( )

Validate ADT and parse error codes.

Returns: boolean

Reimplemented from ilADTFormBridge.

Definition at line 95 of file class.ilADTGroupFormBridge.php.

    {
        global $DIC;
 
        $lng = $DIC['lng'];
        
        $valid = true;
        
        // ilADTFormBridge->isRequired() != ilADT->allowNull()
        foreach ($this->getElements() as $element_id => $element) {
            if ($element->isRequired() && $element->getADT()->isNull()) {
                $field = $this->getForm()->getItemByPostvar($element_id);
                $field->setAlert($lng->txt("msg_input_is_required"));
                $valid = false;
            }
            // #17232 - date time input GUI special case
            elseif (!$element->validate()) {
                $valid = false;
            }
        }
                
        if (!$this->getADT()->isValid()) {
            $tmp = array();
            
            // map errors to elements
            
            $mess = $this->getADT()->getValidationErrorsByElements();
            foreach ($mess as $error_code => $element_id) {
                $tmp[$element_id][] = $this->getADT()->translateErrorCode($error_code);
            }
            
            foreach ($tmp as $element_id => $errors) {
                $field = $this->getForm()->getItemByPostvar($element_id);
                $field->setAlert(implode("<br />", $errors));
            }
            
            $valid = false;
        }
        
        return $valid;
    }

References $DIC, $errors, $lng, $valid, ilADTFormBridge\getADT(), getElements(), and ilADTFormBridge\getForm().

Here is the call graph for this function:

Field Documentation

◆ $elements

ilADTGroupFormBridge::$elements = []

protected

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

Referenced by getElements().

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

Services/ADT/classes/Types/Group/class.ilADTGroupFormBridge.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ addJS()

◆ addToForm()

◆ getElement()

◆ getElements()

◆ importFromPost()

◆ isValidADT()

◆ prepareElements()

◆ validate()

Field Documentation

◆ $elements