ilADTFormBridge Class Reference

ADT form bridge base class. More...

Inheritance diagram for ilADTFormBridge:

Collaboration diagram for ilADTFormBridge:

Public Member Functions
	__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)
	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
ilADT	$adt
ilPropertyFormGUI	$form
	$parent
string	$id = null
string	$title = ''
string	$info = ''
	$parent_element
bool	$required = false
bool	$disabled = false
ilLanguage	$lng

Detailed Description

ADT form bridge base class.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

Definition at line 12 of file class.ilADTFormBridge.php.

Constructor & Destructor Documentation

__construct()

ilADTFormBridge::__construct

(

ilADT

$a_adt

)

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

References $DIC, isValidADT(), ILIAS\Repository\lng(), and setADT().

    {
        global $DIC;

        $this->lng = $DIC->language();

        $this->setADT($a_adt);
    }

Here is the call graph for this function:

Member Function Documentation

addBasicFieldProperties()

ilADTFormBridge::addBasicFieldProperties ( ilFormPropertyGUI  $a_field, ilADTDefinition  $a_def  )

protected

Helper method to handle generic properties like setRequired(), setInfo()

Parameters

ilFormPropertyGUI	$a_field
ilADTDefinition	$a_def

Definition at line 142 of file class.ilADTFormBridge.php.

References getInfo(), isDisabled(), isRequired(), ilFormPropertyGUI\setDisabled(), ilFormPropertyGUI\setInfo(), and ilFormPropertyGUI\setRequired().

Referenced by ilADTTextFormBridge\addElementToForm(), ilADTLocationFormBridge\addToForm(), ilADTMultiTextFormBridge\addToForm(), ilADTBooleanFormBridge\addToForm(), ilADTDateFormBridge\addToForm(), ilADTMultiEnumFormBridge\addToForm(), ilADTInternalLinkFormBridge\addToForm(), ilADTIntegerFormBridge\addToForm(), ilADTFloatFormBridge\addToForm(), ilADTEnumFormBridge\addToForm(), ilADTDateTimeFormBridge\addToForm(), and ilADTExternalLinkFormBridge\addToForm().

                                                                                                  : void
    {
        if ($this->isDisabled()) {
            $a_field->setDisabled(true);
        } elseif ($this->isRequired()) {
            $a_field->setRequired(true);
        }

        $info = $this->getInfo();
        if ($info) {
            $a_field->setInfo($info);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addJS()

ilADTFormBridge::addJS

(

ilGlobalTemplateInterface

$a_tpl

)

Add ADT-specific JS-files to template.

Parameters

ilGlobalTemplate

$a_tpl

Definition at line 204 of file class.ilADTFormBridge.php.

                                                           : void
    {
    }

addToForm()

ilADTFormBridge::addToForm ( )

abstract

Add ADT-specific fields to form.

Referenced by addToParentElement().

Here is the caller graph for this function:

addToParentElement()

ilADTFormBridge::addToParentElement ( ilFormPropertyGUI  $a_field )

protected

Definition at line 185 of file class.ilADTFormBridge.php.

References addToForm(), findParentElementInForm(), and getForm().

Referenced by ilADTTextFormBridge\addElementToForm(), ilADTLocationFormBridge\addToForm(), ilADTMultiTextFormBridge\addToForm(), ilADTBooleanFormBridge\addToForm(), ilADTDateFormBridge\addToForm(), ilADTMultiEnumFormBridge\addToForm(), ilADTInternalLinkFormBridge\addToForm(), ilADTIntegerFormBridge\addToForm(), ilADTFloatFormBridge\addToForm(), ilADTEnumFormBridge\addToForm(), ilADTDateTimeFormBridge\addToForm(), and ilADTExternalLinkFormBridge\addToForm().

                                                                     : void
    {
        $field = $this->findParentElementInForm();
        if ($field instanceof ilSubEnabledFormPropertyGUI) {
            $field->addSubItem($a_field);
        } elseif ($this->getForm() instanceof ilPropertyFormGUI) {
            $this->getForm()->addItem($a_field);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

findParentElementInForm()

ilADTFormBridge::findParentElementInForm ( )

protected

Definition at line 156 of file class.ilADTFormBridge.php.

References getForm(), and getParentElement().

Referenced by addToParentElement().

                                                : ?ilFormPropertyGUI
    {
        $parent_def = $this->getParentElement();
        $parent_option = '';
        if ($parent_def) {
            if (is_array($parent_def)) {
                $parent_option = $parent_def[1];
                $parent_def = $parent_def[0];
            }
            $parent_field = $this->getForm()->getItemByPostVar($parent_def);
            if ($parent_field instanceof ilSubEnabledFormPropertyGUI) {
                // radio/checkbox group
                if ($parent_option && method_exists($parent_field, "getOptions")) {
                    foreach ($parent_field->getOptions() as $option) {
                        if ($option->getValue() == $parent_option) {
                            $parent_field = $option;
                            break;
                        }
                    }
                }
            }

            if ($parent_field) {
                return $parent_field;
            }
        }
        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getADT()

ilADTFormBridge::getADT

(

)

Definition at line 48 of file class.ilADTFormBridge.php.

References $adt.

Referenced by ilADTTextFormBridge\addElementToForm(), ilADTBooleanFormBridge\addToForm(), ilADTLocationFormBridge\addToForm(), ilADTMultiTextFormBridge\addToForm(), ilADTDateFormBridge\addToForm(), ilADTLocalizedTextFormBridge\addToForm(), ilADTMultiEnumFormBridge\addToForm(), ilADTInternalLinkFormBridge\addToForm(), ilADTIntegerFormBridge\addToForm(), ilADTFloatFormBridge\addToForm(), ilADTEnumFormBridge\addToForm(), ilADTDateTimeFormBridge\addToForm(), ilADTExternalLinkFormBridge\addToForm(), ilADTTextFormBridge\addToForm(), ilADTBooleanFormBridge\importFromPost(), ilADTMultiTextFormBridge\importFromPost(), ilADTDateFormBridge\importFromPost(), ilADTDateTimeFormBridge\importFromPost(), ilADTInternalLinkFormBridge\importFromPost(), ilADTMultiEnumFormBridge\importFromPost(), ilADTLocationFormBridge\importFromPost(), ilADTIntegerFormBridge\importFromPost(), ilADTFloatFormBridge\importFromPost(), ilADTExternalLinkFormBridge\importFromPost(), ilADTEnumFormBridge\importFromPost(), ilADTLocalizedTextFormBridge\importFromPost(), ilADTTextFormBridge\importFromPost(), ilADTBooleanFormBridge\isActiveForSubItems(), ilADTMultiEnumFormBridge\isActiveForSubItems(), ilADTEnumFormBridge\isActiveForSubItems(), isActiveForSubItems(), ilADTGroupFormBridge\prepareElements(), ilADTGroupFormBridge\validate(), and validate().

                            : ilADT
    {
        return $this->adt;
    }

Here is the caller graph for this function:

getElementId()

ilADTFormBridge::getElementId

(

)

Definition at line 72 of file class.ilADTFormBridge.php.

References $id.

Referenced by ilADTDateFormBridge\addToElementId(), ilADTBooleanFormBridge\addToForm(), ilADTLocationFormBridge\addToForm(), ilADTMultiTextFormBridge\addToForm(), ilADTDateFormBridge\addToForm(), ilADTLocalizedTextFormBridge\addToForm(), ilADTMultiEnumFormBridge\addToForm(), ilADTInternalLinkFormBridge\addToForm(), ilADTIntegerFormBridge\addToForm(), ilADTFloatFormBridge\addToForm(), ilADTEnumFormBridge\addToForm(), ilADTDateTimeFormBridge\addToForm(), ilADTExternalLinkFormBridge\addToForm(), ilADTTextFormBridge\addToForm(), ilADTBooleanFormBridge\importFromPost(), ilADTMultiTextFormBridge\importFromPost(), ilADTDateFormBridge\importFromPost(), ilADTDateTimeFormBridge\importFromPost(), ilADTInternalLinkFormBridge\importFromPost(), ilADTMultiEnumFormBridge\importFromPost(), ilADTLocationFormBridge\importFromPost(), ilADTIntegerFormBridge\importFromPost(), ilADTFloatFormBridge\importFromPost(), ilADTExternalLinkFormBridge\importFromPost(), ilADTEnumFormBridge\importFromPost(), ilADTLocalizedTextFormBridge\importFromPost(), ilADTTextFormBridge\importFromPost(), setExternalErrors(), and validate().

                                  : ?string
    {
        return $this->id;
    }

Here is the caller graph for this function:

getForm()

ilADTFormBridge::getForm

(

)

Definition at line 58 of file class.ilADTFormBridge.php.

References $form.

Referenced by ilADTGroupFormBridge\addToForm(), addToParentElement(), findParentElementInForm(), ilADTBooleanFormBridge\importFromPost(), ilADTMultiTextFormBridge\importFromPost(), ilADTDateFormBridge\importFromPost(), ilADTDateTimeFormBridge\importFromPost(), ilADTInternalLinkFormBridge\importFromPost(), ilADTMultiEnumFormBridge\importFromPost(), ilADTLocationFormBridge\importFromPost(), ilADTIntegerFormBridge\importFromPost(), ilADTFloatFormBridge\importFromPost(), ilADTExternalLinkFormBridge\importFromPost(), ilADTEnumFormBridge\importFromPost(), ilADTLocalizedTextFormBridge\importFromPost(), ilADTTextFormBridge\importFromPost(), ilADTGroupFormBridge\prepareElements(), ilADTTestGUI\prepareFormElements(), setExternalErrors(), ilADTGroupFormBridge\validate(), and validate().

                             : ?ilPropertyFormGUI
    {
        return $this->form;
    }

Here is the caller graph for this function:

getInfo()

ilADTFormBridge::getInfo

(

)

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

References $info.

Referenced by addBasicFieldProperties(), and ilADTGroupFormBridge\addToForm().

                             : string
    {
        return $this->info;
    }

Here is the caller graph for this function:

getParentElement()

ilADTFormBridge::getParentElement

(

)

Get parent element.

Returns

mixed

Definition at line 112 of file class.ilADTFormBridge.php.

References $parent.

Referenced by findParentElementInForm(), and shouldBeImportedFromPost().

    {
        return $this->parent;
    }

Here is the caller graph for this function:

getTitle()

ilADTFormBridge::getTitle

(

)

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

References $title.

Referenced by ilADTBooleanFormBridge\addToForm(), ilADTLocationFormBridge\addToForm(), ilADTMultiTextFormBridge\addToForm(), ilADTDateFormBridge\addToForm(), ilADTLocalizedTextFormBridge\addToForm(), ilADTMultiEnumFormBridge\addToForm(), ilADTInternalLinkFormBridge\addToForm(), ilADTIntegerFormBridge\addToForm(), ilADTFloatFormBridge\addToForm(), ilADTEnumFormBridge\addToForm(), ilADTDateTimeFormBridge\addToForm(), ilADTExternalLinkFormBridge\addToForm(), ilADTGroupFormBridge\addToForm(), ilADTTextFormBridge\addToForm(), and ilADTExternalLinkFormBridge\importFromPost().

                              : string
    {
        return $this->title;
    }

Here is the caller graph for this function:

importFromPost()

ilADTFormBridge::importFromPost ( )

abstract

Import values from form request POST data.

Referenced by shouldBeImportedFromPost().

Here is the caller graph for this function:

isActiveForSubItems()

ilADTFormBridge::isActiveForSubItems (   $a_parent_option = null )

protected

Check if element is currently active for subitem(s)

Parameters

mixed | null

$a_parent_option

Returns

bool

Definition at line 213 of file class.ilADTFormBridge.php.

References getADT().

                                                                   : bool
    {
        return !$this->getADT()->isNull();
    }

Here is the call graph for this function:

isDisabled()

ilADTFormBridge::isDisabled

(

)

Definition at line 122 of file class.ilADTFormBridge.php.

References $disabled.

Referenced by addBasicFieldProperties(), and shouldBeImportedFromPost().

                                : bool
    {
        return $this->disabled;
    }

Here is the caller graph for this function:

isRequired()

ilADTFormBridge::isRequired

(

)

Definition at line 132 of file class.ilADTFormBridge.php.

References $required.

Referenced by addBasicFieldProperties(), ilADTLocationFormBridge\addToForm(), ilADTEnumFormBridge\addToForm(), ilADTLocationFormBridge\importFromPost(), and validate().

                                : bool
    {
        return $this->required;
    }

Here is the caller graph for this function:

isValidADT()

ilADTFormBridge::isValidADT ( ilADT  $a_adt )

abstractprotected

Referenced by __construct(), and setADT().

Here is the caller graph for this function:

setADT()

ilADTFormBridge::setADT ( ilADT  $a_adt )

protected

Definition at line 40 of file class.ilADTFormBridge.php.

References isValidADT().

Referenced by __construct().

                                           : void
    {
        if (!$this->isValidADT($a_adt)) {
            throw new InvalidArgumentException('ADTFormBridge Type mismatch.');
        }
        $this->adt = $a_adt;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setDisabled()

ilADTFormBridge::setDisabled

(

bool

$a_value

)

Definition at line 117 of file class.ilADTFormBridge.php.

References ILIAS\UI\examples\Input\Field\Checkbox\disabled().

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

Here is the call graph for this function:

setElementId()

ilADTFormBridge::setElementId

(

string

$a_value

)

Set element id (aka form field)

Parameters

string

$a_value

Definition at line 67 of file class.ilADTFormBridge.php.

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

setExternalErrors()

ilADTFormBridge::setExternalErrors

(

array

$a_errors

)

Definition at line 267 of file class.ilADTFormBridge.php.

References getElementId(), and getForm().

                                                      : void
    {
        $field = $this->getForm()->getItemByPostVar($this->getElementId());
        $field->setAlert(implode("<br />", $a_errors));
    }

Here is the call graph for this function:

setForm()

ilADTFormBridge::setForm

(

ilPropertyFormGUI

$a_form

)

Definition at line 53 of file class.ilADTFormBridge.php.

References ILIAS\Repository\form().

                                                      : void
    {
        $this->form = $a_form;
    }

Here is the call graph for this function:

setInfo()

ilADTFormBridge::setInfo

(

string

$a_value

)

Definition at line 87 of file class.ilADTFormBridge.php.

References ILIAS\UI\examples\MessageBox\Info\info().

Referenced by ilADTTestGUI\prepareFormElements().

                                            : void
    {
        $this->info = trim($a_value);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setParentElement()

ilADTFormBridge::setParentElement

(

$a_value

)

Parameters

mixed

$a_value

Definition at line 100 of file class.ilADTFormBridge.php.

                                              : void
    {
        if (!is_array($a_value)) {
            $a_value = (string) $a_value;
        }
        $this->parent = $a_value;
    }

setRequired()

ilADTFormBridge::setRequired

(

bool

$a_value

)

Definition at line 127 of file class.ilADTFormBridge.php.

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

setTitle()

ilADTFormBridge::setTitle

(

string

$a_value

)

Definition at line 77 of file class.ilADTFormBridge.php.

Referenced by ilADTTestGUI\prepareFormElements().

                                             : void
    {
        $this->title = trim($a_value);
    }

Here is the caller graph for this function:

shouldBeImportedFromPost()

ilADTFormBridge::shouldBeImportedFromPost

(

ilADTFormBridge

$a_parent_adt = null

)

Check if incoming values should be imported at all.

Parameters

ilADTFormBridge

$a_parent_adt

Returns

bool

Definition at line 223 of file class.ilADTFormBridge.php.

References $parent_element, getParentElement(), importFromPost(), and isDisabled().

                                                                                  : bool
    {
        if ($this->isDisabled()) {
            return false;
        }

        // inactive parent elements disable importing
        if ($a_parent_adt) {
            $parent_option = null;
            $parent_element = $this->getParentElement();
            if (is_array($parent_element)) {
                $parent_option = $parent_element[1];
            }
            return $a_parent_adt->isActiveForSubItems($parent_option);
        }
        return true;
    }

Here is the call graph for this function:

validate()

ilADTFormBridge::validate

(

)

Definition at line 246 of file class.ilADTFormBridge.php.

References getADT(), getElementId(), getForm(), isRequired(), and ILIAS\Repository\lng().

                              : bool
    {
        // ilADTFormBridge->isRequired() != ilADT->allowNull()
        if ($this->isRequired() && $this->getADT()->isNull()) {
            $field = $this->getForm()->getItemByPostVar($this->getElementId());
            $field->setAlert($this->lng->txt("msg_input_is_required"));
            return false;
        } // no need to further validate if no value given
        elseif (!$this->getADT()->isValid()) {
            $tmp = [];
            $mess = $this->getADT()->getValidationErrors();
            foreach ($mess as $error_code) {
                $tmp[] = $this->getADT()->translateErrorCode($error_code);
            }
            $field = $this->getForm()->getItemByPostVar($this->getElementId());
            $field->setAlert(implode("<br />", $tmp));
            return false;
        }
        return true;
    }

Here is the call graph for this function:

Field Documentation

$adt

ilADT ilADTFormBridge::$adt

protected

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

Referenced by ilADTLocationFormBridge\addToForm(), and getADT().

$disabled

bool ilADTFormBridge::$disabled = false

protected

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

Referenced by isDisabled().

$form

ilPropertyFormGUI ilADTFormBridge::$form

protected

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

Referenced by getForm().

$id

string ilADTFormBridge::$id = null

protected

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

Referenced by getElementId().

$info

string ilADTFormBridge::$info = ''

protected

Definition at line 22 of file class.ilADTFormBridge.php.

Referenced by getInfo().

$lng

ilLanguage ilADTFormBridge::$lng

protected

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

$parent

ilADTFormBridge::$parent

protected

Definition at line 19 of file class.ilADTFormBridge.php.

Referenced by getParentElement(), and ilADTGroupFormBridge\importFromPost().

$parent_element

ilADTFormBridge::$parent_element

protected

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

Referenced by shouldBeImportedFromPost().

$required

bool ilADTFormBridge::$required = false

protected

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

Referenced by isRequired().

$title

string ilADTFormBridge::$title = ''

protected

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

Referenced by ilADTLocationFormBridge\addToForm(), ilADTExternalLinkFormBridge\addToForm(), and getTitle().

---

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

• Services/ADT/classes/Bridges/class.ilADTFormBridge.php