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 ($a_value, $a_cols=null, $a_rows=null)
	Set multi-line. More...
	isMulti ()
	Is multi-line? More...
	addToForm ()
	importFromPost ()
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)
	addElementToForm (string $title, string $element_id, string $value, bool $is_translation=false, string $language='')
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
	$multi
	$multi_rows
	$multi_cols
Protected Attributes inherited from ilADTFormBridge
	$adt
	$form
	$id
	$title
	$info
	$parent_element
	$required
	$disabled

Private Attributes
	$language = null

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 19 of file class.ilADTTextFormBridge.php.

Constructor & Destructor Documentation

__construct()

ilADTTextFormBridge::__construct

(

ilADT

$a_adt

)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and language().

    {
        global $DIC;

        parent::__construct($a_adt);
        $this->language = $DIC->language();
        $this->language->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

Parameters

string	$title
string	$element_id
string	$value
bool	$is_translation
string	$language

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

References $language, $size, ilADTFormBridge\addBasicFieldProperties(), ilADTFormBridge\addToParentElement(), ilADTFormBridge\getADT(), isMulti(), and language().

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

    {
        $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->language->txt('md_adv_int_translation_info') . ' ' . $this->language->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 126 of file class.ilADTTextFormBridge.php.

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

    {
        $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 135 of file class.ilADTTextFormBridge.php.

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

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

(

)

Is multi-line?

Returns

bool

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

References $multi.

Referenced by addElementToForm().

    {
        return $this->multi;
    }

Here is the caller graph for this function:

isValidADT()

ilADTTextFormBridge::isValidADT ( ilADT  $a_adt )

protected

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

    {
        return ($a_adt instanceof ilADTText);
    }

setMulti()

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

Set multi-line.

Parameters

string	$a_value
int	$a_cols
int	$a_rows

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

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

Field Documentation

$language

ilADTTextFormBridge::$language = null

private

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

Referenced by addElementToForm(), and ilADTLocalizedTextFormBridge\importFromPost().

$multi

ilADTTextFormBridge::$multi

protected

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

Referenced by isMulti().

$multi_cols

ilADTTextFormBridge::$multi_cols

protected

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

$multi_rows

ilADTTextFormBridge::$multi_rows

protected

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

---

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

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