ilADTTextFormBridge Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilADTTextFormBridge:

Collaboration diagram for ilADTTextFormBridge:

Public Member Functions
	__construct (ilADT $a_adt)
	setMulti (bool $a_value, ?int $a_cols=null, ?int $a_rows=null)
	isMulti ()
	addToForm ()
	importFromPost ()
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)
	addElementToForm (string $title, string $element_id, string $value, bool $is_translation=false, string $language='')
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
bool	$multi = false
int	$multi_rows
int	$multi_cols
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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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

Constructor & Destructor Documentation

__construct()

ilADTTextFormBridge::__construct

(

ilADT

$a_adt

)

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

References ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\lng().

    {
        parent::__construct($a_adt);
        $this->lng->loadLanguageModule('meta');
    }

Here is the call graph for this function:

Member Function Documentation

addElementToForm()

ilADTTextFormBridge::addElementToForm ( string  $title, string  $element_id, string  $value, bool  $is_translation = false, string  $language = ''  )

protected

Definition at line 50 of file class.ilADTTextFormBridge.php.

References ilADTFormBridge\addBasicFieldProperties(), ilADTFormBridge\addToParentElement(), ilADTFormBridge\getADT(), isMulti(), and ILIAS\Repository\lng().

Referenced by ilADTLocalizedTextFormBridge\addToForm(), and addToForm().

     : void {
        $def = $this->getADT()->getCopyOfDefinition();

        if (!$this->isMulti()) {
            $text = new ilTextInputGUI($title, $element_id);

            if ($def->getMaxLength()) {
                $max = $def->getMaxLength();
                $size = $text->getSize();

                $text->setMaxLength($max);

                if ($size && $max < $size) {
                    $text->setSize($max);
                }
            }
        } else {
            $text = new ilTextAreaInputGUI($title, $element_id);
            if ($this->multi_rows) {
                $text->setRows($this->multi_rows);
            }
            if ($this->multi_cols) {
                $text->setCols($this->multi_cols);
            }

            if ($def->getMaxLength()) {
                $max = $def->getMaxLength();
                $text->setMaxNumOfChars($max);
            }
        }
        $this->addBasicFieldProperties($text, $def);

        if ($is_translation) {
            $text->setInfo($this->lng->txt('md_adv_int_translation_info') . ' ' . $this->lng->txt('meta_l_' . $language));
            $text->setRequired(false);
        }
        $text->setValue($value);
        $this->addToParentElement($text);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addToForm()

ilADTTextFormBridge::addToForm

(

)

Definition at line 96 of file class.ilADTTextFormBridge.php.

References addElementToForm(), ilADTFormBridge\getADT(), ilADTFormBridge\getElementId(), and ilADTFormBridge\getTitle().

                               : void
    {
        $this->addElementToForm(
            (string) $this->getTitle(),
            (string) $this->getElementId(),
            (string) $this->getADT()->getText()
        );
    }

Here is the call graph for this function:

importFromPost()

ilADTTextFormBridge::importFromPost

(

)

Definition at line 105 of file class.ilADTTextFormBridge.php.

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

                                    : void
    {
        // ilPropertyFormGUI::checkInput() is pre-requisite
        $this->getADT()->setText($this->getForm()->getInput($this->getElementId()));
        $field = $this->getForm()->getItemByPostVar($this->getElementId());
        $field->setValue($this->getADT()->getText());
    }

Here is the call graph for this function:

isMulti()

ilADTTextFormBridge::isMulti

(

)

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

References $multi.

Referenced by addElementToForm().

                             : bool
    {
        return $this->multi;
    }

Here is the caller graph for this function:

isValidADT()

ilADTTextFormBridge::isValidADT ( ilADT  $a_adt )

protected

Definition at line 45 of file class.ilADTTextFormBridge.php.

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

setMulti()

ilADTTextFormBridge::setMulti	(	bool	$a_value,
		?int	$a_cols = null,
		?int	$a_rows = null
	)

Definition at line 33 of file class.ilADTTextFormBridge.php.

                                                                                     : void
    {
        $this->multi = $a_value;
        $this->multi_rows = ($a_rows === null) ? null : $a_rows;
        $this->multi_cols = ($a_cols === null) ? null : $a_cols;
    }

Field Documentation

$multi

bool ilADTTextFormBridge::$multi = false

protected

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

Referenced by isMulti().

$multi_cols

int ilADTTextFormBridge::$multi_cols

protected

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

$multi_rows

int ilADTTextFormBridge::$multi_rows

protected

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

---

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

• Services/ADT/classes/Types/Text/class.ilADTTextFormBridge.php