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

Inheritance diagram for ilTagInputGUI:

Collaboration diagram for ilTagInputGUI:

Public Member Functions
	setMaxTags (int $max_tags)

	setMaxChars (int $max_chars)

	setAllowDuplicates (bool $allow_duplicates)

	setJsSelfInit (bool $js_self_init)

	setTypeAheadIgnoreCase (bool $type_ahead_ignore_case)

	setTypeAheadMinLength (int $min_length)

	setTypeAheadLimit (int $limit)

	setTypeAheadHighlight (bool $highlight)

	setTypeAheadList (array $type_ahead_list)

	setOptions (?array $a_options)

	getOptions ()

	__construct (string $a_title='', string $a_postvar='')

	setValueByArray ($a_values)
	Set value by array. More...

	checkInput ()

	render ()

	insert (ilTemplate $tpl)

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem (ilFormPropertyGUI $a_item)

	getSubItems ()

	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()

	getItemByPostVar (string $a_post_var)

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
ilGlobalTemplateInterface	$tpl

array	$options = null

int	$max_tags = 0

int	$max_chars = 0

bool	$allow_duplicates = false

bool	$js_self_init = true

bool	$type_ahead_ignore_case = true

array	$type_ahead_list = []

int	$type_ahead_min_length = 2

int	$type_ahead_limit = 30

bool	$type_ahead_highlight = true

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
array	$sub_items = array()

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

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 This class represents a tag list property in a property form.

Author: Guido Vollbach gvoll.nosp@m.bach.nosp@m.@data.nosp@m.bay..nosp@m.de

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

Constructor & Destructor Documentation

◆ __construct()

ilTagInputGUI::__construct	(	string	$a_title = `''`,
		string	$a_postvar = `''`
	)

Definition at line 95 of file class.ilTagInputGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setType().

     {
         global $DIC;
         $this->tpl = $DIC['tpl'];
         $this->lng = $DIC->language();
         parent::__construct($a_title, $a_postvar);
         $this->setType('tag_input');
         $this->tpl->addJavaScript('assets/js/bootstrap-tagsinput_2015_25_03.js');
         $this->tpl->addJavaScript('assets/js/typeahead_0.11.1.js');
         $this->tpl->addCss('assets/css/bootstrap-tagsinput_2015_25_03.css');
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilTagInputGUI::checkInput ( )

Definition at line 120 of file class.ilTagInputGUI.php.

References ilFormPropertyGUI\$lng, $valid, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), ilFormPropertyGUI\strArray(), and ilLanguage\txt().

                                 : bool
     {
         $lng = $this->lng;
         $valid = true;
 
         $values = array_filter($this->strArray($this->getPostVar()));
         if ($values === [] && $this->getRequired()) {
             $this->setAlert($lng->txt(msg_input_is_required));
             return false;
         }
         return $this->checkSubItemsInput();
     }

Here is the call graph for this function:

◆ getOptions()

ilTagInputGUI::getOptions ( )

Definition at line 90 of file class.ilTagInputGUI.php.

Referenced by render().

                                 : array
     {
         return $this->options ? $this->options : [];
     }

Here is the caller graph for this function:

◆ insert()

ilTagInputGUI::insert ( ilTemplate $tpl )

Definition at line 176 of file class.ilTagInputGUI.php.

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

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

Here is the call graph for this function:

◆ render()

ilTagInputGUI::render ( )

Definition at line 133 of file class.ilTagInputGUI.php.

References $allow_duplicates, $id, $max_chars, $max_tags, $type_ahead_highlight, $type_ahead_limit, $type_ahead_min_length, ILIAS\UICore\GlobalTemplate\get(), ilFormPropertyGUI\getFieldId(), getOptions(), ilFormPropertyGUI\getPostVar(), ILIAS\UICore\GlobalTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareFormOutput(), ILIAS\UICore\GlobalTemplate\setCurrentBlock(), and ILIAS\UICore\GlobalTemplate\setVariable().

Referenced by insert().

                             : string
     {
         $this->tpl->addJavaScript('assets/js/testQuestionPoolTagInput.js');
         $config = [
             'min_length' => $this->type_ahead_min_length,
             'limit' => $this->type_ahead_limit,
             'highlight' => $this->type_ahead_highlight,
             'case' => '',
             'maxtags' => $this->max_tags,
             'maxchars' => $this->max_chars,
             'allow_duplicates' => $this->allow_duplicates
         ];
         if ($this->type_ahead_ignore_case) {
             $config['case'] = 'i';
         }
 
         $this->tpl->addOnLoadCode(
             'ilBootstrapTaggingOnLoad.initConfig(' . json_encode($config) . ');'
         );
 
         $tpl = new ilTemplate('tpl.prop_tag_typeahead.html', true, true, 'components/ILIAS/TestQuestionPool');
         foreach ($this->getOptions() as $option_text) {
             $tpl->setCurrentBlock('prop_select_option');
             $tpl->setVariable('VAL_SELECT_OPTION', ilLegacyFormElementsUtil::prepareFormOutput($option_text));
             $tpl->setVariable('TXT_SELECT_OPTION', $option_text);
             $tpl->parseCurrentBlock();
         }
 
         $tpl->setVariable('ID', $this->getFieldId());
 
         $tpl->setVariable('POST_VAR', $this->getPostVar() . '[]');
 
         if ($this->js_self_init) {
             $id = preg_replace('/[^\d]+/', '', $this->getFieldId());
             $this->tpl->addOnLoadCode(
                 "ilBootstrapTaggingOnLoad.appendId('#{$this->getFieldId()}');\n"
                 . "ilBootstrapTaggingOnLoad.appendTerms({$id}, " . json_encode($this->type_ahead_list) . ");\n"
                 . 'ilBootstrapTaggingOnLoad.Init();'
             );
         }
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAllowDuplicates()

ilTagInputGUI::setAllowDuplicates ( bool $allow_duplicates )

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

References $allow_duplicates.

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

◆ setJsSelfInit()

ilTagInputGUI::setJsSelfInit ( bool $js_self_init )

Definition at line 55 of file class.ilTagInputGUI.php.

References $js_self_init.

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

◆ setMaxChars()

ilTagInputGUI::setMaxChars ( int $max_chars )

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

References $max_chars.

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

◆ setMaxTags()

ilTagInputGUI::setMaxTags ( int $max_tags )

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

References $max_tags.

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

◆ setOptions()

ilTagInputGUI::setOptions ( ?array $a_options )

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

Referenced by setValueByArray().

                                                  : void
     {
         $this->options = $a_options;
     }

Here is the caller graph for this function:

◆ setTypeAheadHighlight()

ilTagInputGUI::setTypeAheadHighlight ( bool $highlight )

Definition at line 75 of file class.ilTagInputGUI.php.

                                                           : void
     {
         $this->type_ahead_highlight = $highlight;
     }

◆ setTypeAheadIgnoreCase()

ilTagInputGUI::setTypeAheadIgnoreCase ( bool $type_ahead_ignore_case )

Definition at line 60 of file class.ilTagInputGUI.php.

References $type_ahead_ignore_case.

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

◆ setTypeAheadLimit()

ilTagInputGUI::setTypeAheadLimit ( int $limit )

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

                                                  : void
     {
         $this->type_ahead_limit = $limit;
     }

◆ setTypeAheadList()

ilTagInputGUI::setTypeAheadList ( array $type_ahead_list )

Definition at line 80 of file class.ilTagInputGUI.php.

References $type_ahead_list.

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

◆ setTypeAheadMinLength()

ilTagInputGUI::setTypeAheadMinLength ( int $min_length )

Definition at line 65 of file class.ilTagInputGUI.php.

                                                           : void
     {
         $this->type_ahead_min_length = $min_length;
     }

◆ setValueByArray()

ilTagInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

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

References ilFormPropertyGUI\getPostVar(), ilSubEnabledFormPropertyGUI\getSubItems(), and setOptions().

                                               : void
     {
         $this->setOptions($a_values[$this->getPostVar()]);
         foreach ($this->getSubItems() as $item) {
             $item->setValueByArray($a_values);
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $allow_duplicates

bool ilTagInputGUI::$allow_duplicates = false

protected

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

Referenced by render(), and setAllowDuplicates().

◆ $js_self_init

bool ilTagInputGUI::$js_self_init = true

protected

Definition at line 32 of file class.ilTagInputGUI.php.

Referenced by setJsSelfInit().

◆ $max_chars

int ilTagInputGUI::$max_chars = 0

protected

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

Referenced by render(), and setMaxChars().

◆ $max_tags

int ilTagInputGUI::$max_tags = 0

protected

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

Referenced by render(), and setMaxTags().

◆ $options

array ilTagInputGUI::$options = null

protected

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

◆ $tpl

ilGlobalTemplateInterface ilTagInputGUI::$tpl

protected

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

◆ $type_ahead_highlight

bool ilTagInputGUI::$type_ahead_highlight = true

protected

Definition at line 38 of file class.ilTagInputGUI.php.

Referenced by render().

◆ $type_ahead_ignore_case

bool ilTagInputGUI::$type_ahead_ignore_case = true

protected

Definition at line 34 of file class.ilTagInputGUI.php.

Referenced by setTypeAheadIgnoreCase().

◆ $type_ahead_limit

int ilTagInputGUI::$type_ahead_limit = 30

protected

Definition at line 37 of file class.ilTagInputGUI.php.

Referenced by render().

◆ $type_ahead_list

array ilTagInputGUI::$type_ahead_list = []

protected

Definition at line 35 of file class.ilTagInputGUI.php.

Referenced by setTypeAheadList().

◆ $type_ahead_min_length

int ilTagInputGUI::$type_ahead_min_length = 2

protected

Definition at line 36 of file class.ilTagInputGUI.php.

Referenced by render().

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

components/ILIAS/TestQuestionPool/classes/forms/class.ilTagInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getOptions()

◆ insert()

◆ render()

◆ setAllowDuplicates()

◆ setJsSelfInit()

◆ setMaxChars()

◆ setMaxTags()

◆ setOptions()

◆ setTypeAheadHighlight()

◆ setTypeAheadIgnoreCase()

◆ setTypeAheadLimit()

◆ setTypeAheadList()

◆ setTypeAheadMinLength()

◆ setValueByArray()

Field Documentation

◆ $allow_duplicates

◆ $js_self_init

◆ $max_chars

◆ $max_tags

◆ $options

◆ $tpl

◆ $type_ahead_highlight

◆ $type_ahead_ignore_case

◆ $type_ahead_limit

◆ $type_ahead_list

◆ $type_ahead_min_length