ilADTGroupFormBridge Class Reference

Inheritance diagram for ilADTGroupFormBridge:

Collaboration diagram for ilADTGroupFormBridge:

Public Member Functions
	getElements ()
	getElement (string $a_name)
	addToForm ()
	addJS (ilGlobalTemplateInterface $a_tpl)
	importFromPost ()
	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)
	prepareElements ()
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	$elements = []
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.ilADTGroupFormBridge.php.

Member Function Documentation

addJS()

ilADTGroupFormBridge::addJS

(

ilGlobalTemplateInterface

$a_tpl

)

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

References prepareElements().

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

Here is the call graph for this function:

addToForm()

ilADTGroupFormBridge::addToForm

(

)

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

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

                               : void
    {
        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();
        }
    }

Here is the call graph for this function:

getElement()

ilADTGroupFormBridge::getElement

(

string

$a_name

)

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

References prepareElements().

Referenced by ilADTTestGUI\prepareFormElements().

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

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.

References $elements, and prepareElements().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

importFromPost()

ilADTGroupFormBridge::importFromPost

(

)

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

References ilADTFormBridge\$parent, and prepareElements().

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

Here is the call graph for this function:

isValidADT()

ilADTGroupFormBridge::isValidADT ( ilADT  $a_adt )

protected

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

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

prepareElements()

ilADTGroupFormBridge::prepareElements ( )

protected

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

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

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

                                        : void
    {
        if (count($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((string) $name);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

validate()

ilADTGroupFormBridge::validate

(

)

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

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

                              : bool
    {
        $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($this->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((string) $element_id);
                $field->setAlert(implode("<br />", $errors));
            }

            $valid = false;
        }

        return $valid;
    }

Here is the call graph for this function:

Field Documentation

$elements

array 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