ilDclGenericMultiInputGUI Class Reference

Inheritance diagram for ilDclGenericMultiInputGUI:

Collaboration diagram for ilDclGenericMultiInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")
	setInput (ilFormPropertyGUI $input)
	setValue (string $value)
	setValueByArray (array $a_values)
	checkInput ()
	Check input, strip slashes etc. More...
	getInput ()
	render (int $iterator_id)
	insert (ilTemplate $a_tpl)
Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")
	executeCommand ()
	getType ()
	setTitle (string $a_title)
	getTitle ()
	setPostVar (string $a_postvar)
	getPostVar ()
	getFieldId ()
	setInfo (string $a_info)
	getInfo ()
	setAlert (string $a_alert)
	getAlert ()
	setRequired (bool $a_required)
	getRequired ()
	setDisabled (bool $a_disabled)
	getDisabled ()
	checkInput ()
	Check input, strip slashes etc. More...
	setParentForm (ilPropertyFormGUI $a_parentform)
	getParentForm ()
	setParent (ilFormPropertyGUI $a_val)
	getParent ()
	getSubForm ()
	hideSubForm ()
	setHiddenTitle (string $a_val)
	getHiddenTitle ()
	getItemByPostVar (string $a_post_var)
	Get item by post var. More...
	serializeData ()
	unserializeData (string $a_data)
	setParentTable ($a_val)
	Set parent table. More...
	getParentTable ()
	Get parent table. More...
	writeToSession ()
	clearFromSession ()
	readFromSession ()
	getHiddenTag (string $a_post_var, string $a_value)
	setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)
	getMulti ()
	setMultiValues (array $a_values)
	getMultiValues ()
	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...
	stripSlashesAddSpaceFallback (string $a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...
	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...
	getFormLabelFor ()
	Get label "for" attribute value for form. More...
	setRequestParam (string $key, $val)
	This writes the request (aka post) values. More...

Protected Attributes
Factory	$ui_factory
Renderer	$renderer
ilObjUser	$user
ilFormPropertyGUI	$input
array	$line_values = []
Protected Attributes inherited from ilFormPropertyGUI
array	$set_params = []
ilTable2GUI	$parent_table = null
ilFormPropertyGUI	$parent_gui = null
ilCtrl	$ctrl
ilLanguage	$lng
string	$type = ""
string	$title = ""
string	$postvar = ""
string	$info = ""
string	$alert = ""
bool	$required = false
ilPropertyFormGUI	$parentform = null
string	$hidden_title = ""
bool	$multi = false
bool	$multi_sortable = false
bool	$multi_addremove = true
array	$multi_values = []
RequestInterface	$request
HTTP Services	$http
Refinery Factory	$refinery = null
bool	$disabled = false
ilGlobalTemplateInterface	$global_tpl = null

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters (string $a_text)
	Remove prohibited characters see #19159. More...
Protected Member Functions inherited from ilFormPropertyGUI
	symbol ()
	setType (string $a_type)
	checkParentFormTable ()
	getSessionKey ()
	getMultiIconsHTML ()
	int ($key)
	intArray ($key)
	str ($key)
	raw ($key)
	strArray ($key)
	arrayArray ($key)
	isRequestParamArray (string $key)
	getRequestParam (string $key, Refinery\Transformation $t)

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilDclGenericMultiInputGUI::__construct	(	string	$a_title = "",
		string	$a_postvar = ""
	)

Reimplemented from ilFormPropertyGUI.

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

    {
        global $DIC;
 
        $this->user = $DIC->user();
        $this->ui_factory = $DIC->ui()->factory();
        $this->renderer = $DIC->ui()->renderer();
 
        parent::__construct($a_title, $a_postvar);
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), renderer(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

checkInput()

ilDclGenericMultiInputGUI::checkInput

(

)

Check input, strip slashes etc.

set alert, if input is not ok.

Reimplemented from ilFormPropertyGUI.

Definition at line 64 of file class.ilDclGenericMultiInputGUI.php.

                                : bool
    {
        return true;
    }

getInput()

ilDclGenericMultiInputGUI::getInput

(

)

Definition at line 69 of file class.ilDclGenericMultiInputGUI.php.

                              : array
    {
        return $this->strArray($this->getPostVar());
    }

References ilFormPropertyGUI\getPostVar(), and ilFormPropertyGUI\strArray().

Here is the call graph for this function:

insert()

ilDclGenericMultiInputGUI::insert

(

ilTemplate

$a_tpl

)

Definition at line 93 of file class.ilDclGenericMultiInputGUI.php.

                                             : void
    {
        $output = $this->render(0);
 
        if (is_array($this->line_values) && count($this->line_values) > 0) {
            $counter = 0;
            foreach ($this->line_values as $i => $data) {
                $object = $this;
                $object->setValue($data);
                $output .= $object->render($i);
                $counter++;
            }
        } else {
            $output .= $this->render(1);
        }
 
        $output = '<div id="' . $this->getFieldId() . '" class="multi_line_input">' . $output . '</div>';
        $this->global_tpl->addJavaScript('assets/js/generic_multi_line_input.js');
        $id = $this->getFieldId();
        $this->global_tpl->addOnLoadCode("il.DataCollection.genericMultiLineInit('$id');");
 
        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $output);
        $a_tpl->parseCurrentBlock();
    }

References $counter, $data, $id, ilFormPropertyGUI\getFieldId(), ilTemplate\parseCurrentBlock(), render(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Here is the call graph for this function:

render()

ilDclGenericMultiInputGUI::render

(

int

$iterator_id

)

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

                                            : string
    {
        $tpl = new ilTemplate("tpl.prop_generic_multi_line.html", true, true, 'components/ILIAS/DataCollection');
 
        $input = clone $this->input;
        $input->setPostVar($this->getPostVar() . '[' . $iterator_id . ']');
 
        $tpl->setCurrentBlock('input');
        $tpl->setVariable('CONTENT', $input->render());
        $tpl->parseCurrentBlock();
 
        $tpl->setVariable('IMAGE_PLUS', $this->renderer->render($this->ui_factory->symbol()->glyph()->add()));
        $tpl->setVariable('IMAGE_MINUS', $this->renderer->render($this->ui_factory->symbol()->glyph()->remove()));
        $tpl->setVariable('IMAGE_UP', $this->renderer->render($this->ui_factory->symbol()->glyph()->up()));
        $tpl->setVariable('IMAGE_DOWN', $this->renderer->render($this->ui_factory->symbol()->glyph()->down()));
 
        return $tpl->get();
    }

References $input, ilFormPropertyGUI\getPostVar(), renderer(), and ilFormPropertyGUI\setPostVar().

Referenced by insert().

Here is the call graph for this function:

Here is the caller graph for this function:

setInput()

ilDclGenericMultiInputGUI::setInput

(

ilFormPropertyGUI

$input

)

Definition at line 44 of file class.ilDclGenericMultiInputGUI.php.

                                                      : void
    {
        $this->input = $input;
    }

References $input.

setValue()

ilDclGenericMultiInputGUI::setValue

(

string

$value

)

Definition at line 49 of file class.ilDclGenericMultiInputGUI.php.

                                           : void
    {
        if ($this->input instanceof ilDateTimeInputGUI) {
            $date = new DateTime($value, new DateTimeZone($this->user->getTimeZone()));
            $this->input->setDate(new ilDateTime($date->getTimestamp(), IL_CAL_UNIX));
        } else {
            $this->input->setValue($value);
        }
    }

References IL_CAL_UNIX, and ILIAS\Repository\user().

Here is the call graph for this function:

setValueByArray()

ilDclGenericMultiInputGUI::setValueByArray

(

array

$a_values

)

Definition at line 59 of file class.ilDclGenericMultiInputGUI.php.

                                                    : void
    {
        $this->line_values = $a_values[$this->getPostVar()] ?? [];
    }

References ilFormPropertyGUI\getPostVar().

Here is the call graph for this function:

Field Documentation

$input

ilFormPropertyGUI ilDclGenericMultiInputGUI::$input

protected

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

Referenced by render(), and setInput().

$line_values

array ilDclGenericMultiInputGUI::$line_values = []

protected

Definition at line 31 of file class.ilDclGenericMultiInputGUI.php.

$renderer

Renderer ilDclGenericMultiInputGUI::$renderer

protected

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

$ui_factory

Factory ilDclGenericMultiInputGUI::$ui_factory

protected

Definition at line 26 of file class.ilDclGenericMultiInputGUI.php.

$user

ilObjUser ilDclGenericMultiInputGUI::$user

protected

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

---

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

• components/ILIAS/DataCollection/classes/Helpers/class.ilDclGenericMultiInputGUI.php