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

Inheritance diagram for ilGloAdvColSortInputGUI:

Collaboration diagram for ilGloAdvColSortInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_id="")

	setValue (array $a_value)

	getValue ()

	checkInput ()
	Input should always be valid, since we sort only. More...

	getInput ()

	render ()

	insert (ilTemplate $a_tpl)

	setValueByArray (array $a_values)

	getTableFilterHTML ()

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
array	$value

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

Private Attributes
ILIAS Repository InternalGUIService	$gui

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

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 Input for adv meta data column sorting in glossaries. Please note, that data us already an array, we do not use the MultipleValues interface here.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilGloAdvColSortInputGUI::__construct	(	string	$a_title = `""`,
		string	$a_id = `""`
	)

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

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__construct(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setType().

       {
         global $DIC;
 
         $this->lng = $DIC->language();
         parent::__construct($a_title, $a_id);
         $this->setType("glo_adv_col_sort");
         // temp workaround
         $this->gui = $DIC->repository()->internal()->gui();
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilGloAdvColSortInputGUI::checkInput ( )

Input should always be valid, since we sort only.

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

                                 : bool
     {
         return true;
     }

◆ getInput()

ilGloAdvColSortInputGUI::getInput ( )

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

References ilFormPropertyGUI\arrayArray(), ilFormPropertyGUI\getPostVar(), and ilArrayUtil\stripSlashesRecursive().

                               : array
     {
         $val = $this->arrayArray($this->getPostVar());
         $val = ilArrayUtil::stripSlashesRecursive($val);
         return $val;
     }

Here is the call graph for this function:

◆ getTableFilterHTML()

ilGloAdvColSortInputGUI::getTableFilterHTML ( )

Definition at line 111 of file class.ilGloAdvColSortInputGUI.php.

References render().

                                         : string
     {
         $html = $this->render();
         return $html;
     }

Here is the call graph for this function:

◆ getValue()

ilGloAdvColSortInputGUI::getValue ( )

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

References $value.

Referenced by render().

                               : array
     {
         return $this->value;
     }

Here is the caller graph for this function:

◆ insert()

ilGloAdvColSortInputGUI::insert ( ilTemplate $a_tpl )

Definition at line 97 of file class.ilGloAdvColSortInputGUI.php.

References ilTemplate\parseCurrentBlock(), render(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

                                              : void
     {
         $a_tpl->setCurrentBlock("prop_generic");
         $a_tpl->setVariable("PROP_GENERIC", $this->render());
         $a_tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

◆ render()

ilGloAdvColSortInputGUI::render ( )

Definition at line 70 of file class.ilGloAdvColSortInputGUI.php.

References ilFormPropertyGUI\$lng, ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getPostVar(), getValue(), ilLegacyFormElementsUtil\prepareFormOutput(), and ilLanguage\txt().

Referenced by getTableFilterHTML(), and insert().

                             : string
     {
         $lng = $this->lng;
         $up = $this->gui->symbol()->glyph("up")->render();
         $down = $this->gui->symbol()->glyph("down")->render();
 
         $tpl = new ilTemplate("tpl.adv_col_sort_input.html", true, true, "Modules/Glossary");
         if (is_array($this->getValue())) {
             foreach ($this->getValue() as $k => $v) {
                 $tpl->setCurrentBlock("item");
                 $tpl->setVariable("TEXT", $v["text"]);
                 $tpl->setVariable("ID", $this->getFieldId() . "~" . $k);
                 $tpl->setVariable("DOWN", $down);
                 $tpl->setVariable("TXT_DOWN", $lng->txt("down"));
                 $tpl->setVariable("UP", $up);
                 $tpl->setVariable("TXT_UP", $lng->txt("up"));
                 $tpl->setVariable('NAME', $this->getPostVar() . "[" . $k . "][id]");
                 $tpl->setVariable('TNAME', $this->getPostVar() . "[" . $k . "][text]");
                 $tpl->setVariable('VAL', ilLegacyFormElementsUtil::prepareFormOutput($v["id"]));
                 $tpl->setVariable('TVAL', ilLegacyFormElementsUtil::prepareFormOutput($v["text"]));
                 $tpl->parseCurrentBlock();
             }
         }
 
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValue()

ilGloAdvColSortInputGUI::setValue ( array $a_value )

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

Referenced by setValueByArray().

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

Here is the caller graph for this function:

◆ setValueByArray()

ilGloAdvColSortInputGUI::setValueByArray ( array $a_values )

Definition at line 104 of file class.ilGloAdvColSortInputGUI.php.

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

                                                     : void
     {
         if ($this->getPostVar() && isset($a_values[$this->getPostVar()])) {
             $this->setValue($a_values[$this->getPostVar()]);
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $gui

ILIAS Repository InternalGUIService ilGloAdvColSortInputGUI::$gui

private

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

◆ $value

array ilGloAdvColSortInputGUI::$value

protected

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

Referenced by getValue().

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

Modules/Glossary/Metadata/class.ilGloAdvColSortInputGUI.php

Public Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getInput()

◆ getTableFilterHTML()

◆ getValue()

◆ insert()

◆ render()

◆ setValue()

◆ setValueByArray()

Field Documentation

◆ $gui

◆ $value