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

Inheritance diagram for ilAssNestedOrderingElementsInputGUI:

Collaboration diagram for ilAssNestedOrderingElementsInputGUI:

Public Member Functions
	__construct (ilAssOrderingFormValuesObjectsConverter $converter, $postVar)

	setInteractionEnabled (bool $interaction_enabled)

	setNestingEnabled (bool $nesting_enabled)

	setStylingDisabled (bool $styling_disabled)

	setElementList (ilAssOrderingElementList $elementList)

	getElementList (int $questionId)

	prepareReprintable (assQuestion $question)

	getContext ()

	setContext (string $context)

	getUniquePrefix ()

	setUniquePrefix (int $unique_prefix)

	setOrderingType (int $ordering_type)

	getOrderingType ()

	setElementImagePath (string $element_image_path)

	getElementImagePath ()

	setThumbPrefix (string $thumbnail_filename_prefix)

	getThumbPrefix ()

	setShowCorrectnessIconsEnabled (bool $show_correctness_icons_enabled)

	isShowCorrectnessIconsEnabled ()

	getCorrectnessTrueElementList ()

	setCorrectnessTrueElementList (ilAssOrderingElementList $correctness_true_element_list)

	isPostSubmit ($data)

	render (string $a_mode='')

	onCheckInput ()

	getHTML ()

Public Member Functions inherited from ilIdentifiedMultiValuesInputGUI
	__construct ($a_title="", $a_postvar="")

	getElementAddCmd ()

	setElementAddCmd (string $element_add_cmd)

	getElementRemoveCmd ()

	setElementRemoveCmd (string $element_remove_cmd)

	getElementMoveUpCommand ()

	setElementMoveUpCommand (string $element_move_up_cmd)

	getElementMoveDownCommand ()

	setElementMoveDownCommand (string $element_move_down_cmd)

	setValues ($values)

	getValues ()

	setValue ($value)

	getValue ()

	setMultiValues (array $values)

	getMultiValues ()

	setIdentifiedMultiValues ($values)

	getIdentifiedMultiValues ()

	setValueByArray (array $a_values)

	getInput ()

	checkInput ()

	onCheckInput ()

	prepareReprintable (assQuestion $question)

Public Member Functions inherited from ilTextInputGUI
	__construct (string $a_title="", string $a_postvar="")

	setValue ($a_value)

	getValue ()

	setValidationFailureMessage (string $a_msg)

	getValidationFailureMessage ()

	setValidationRegexp (string $a_value)

	getValidationRegexp ()

	setMaxLength (?int $a_maxlength)

	getMaxLength ()

	setSize (int $a_size)

	setInlineStyle (string $a_style)

	getInlineStyle ()

	setCssClass (string $a_class)

	getCssClass ()

	setValueByArray (array $a_values)

	getSize ()

	setSuffix (string $a_value)

	getSuffix ()

	setInputType (string $a_type)
	set input type More...

	getInputType ()

	setSubmitFormOnEnter (bool $a_val)

	getSubmitFormOnEnter ()

	checkInput ()

	getInput ()

	getDataSource ()

	setDataSource (string $href, string $a_delimiter=null)

	setDataSourceSubmitOnSelection (bool $a_stat)

	getDataSourceSubmitOnSelection ()

	setDataSourceSubmitUrl (string $a_url)

	getDataSourceSubmitUrl ()

	setMultiValues (array $a_values)

	render (string $a_mode="")

	insert (ilTemplate $a_tpl)

	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...

	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

	setDisableHtmlAutoComplete (bool $autocomplete)

	isHtmlAutoCompleteDisabled ()

	getPostValueForComparison ()

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...

Public Member Functions inherited from ilTableFilterItem
	getTableFilterLabelFor ()
	Get label "for" attribute value. More...

Data Fields
const	CONTEXT_QUESTION_PREVIEW = 'QuestionPreview'

const	CONTEXT_CORRECT_SOLUTION_PRESENTATION = 'CorrectSolutionPresent'

const	CONTEXT_USER_SOLUTION_PRESENTATION = 'UserSolutionPresent'

const	CONTEXT_USER_SOLUTION_SUBMISSION = 'UserSolutionSubmit'

Data Fields inherited from ilIdentifiedMultiValuesInputGUI
const	ELEMENT_DEFAULT_ADD_CMD = 'addElement'

const	ELEMENT_DEFAULT_REMOVE_CMD = 'removeElement'

const	ELEMENT_DEFAULT_MOVE_UP_CMD = 'moveUpElement'

const	ELEMENT_DEFAULT_MOVE_DOWN_CMD = 'moveDownElement'

Private Member Functions
	getGlobalTpl ()

	initListTemplate ()

	getCorrectness (int $identifier)

	getCorrectnessIcon ($correctness)

	getItemTemplate ()

	getThumbnailFilename ($element)

	getThumbnailSource ($element)

	getItemHtml (array $element, string $identifier, string $content_post_var, string $position_post_var, string $indentation_post_var)

	renderListItem (array $value, string $identifier, string $children)

	renderMainList ()

	addIdentifierToValues (array $values)

	buildHierarchicalTreeFromDBValues (array $values)

	buildHTMLView (array $array, \Closure $sort_closure)

	initializePlayerJS ()

Private Attributes
const	POSTVAR_CONTENT = 'content'

const	POSTVAR_POSITION = 'position'

const	POSTVAR_INDENTATION = 'indentation'

const	DEFAULT_THUMBNAIL_PREFIX = 'thumb.'

string	$context = null

int	$unique_prefix = null

int	$ordering_type = null

string	$thumbnail_filename_prefix = self::DEFAULT_THUMBNAIL_PREFIX

string	$element_image_path = null

bool	$show_correctness_icons_enabled = false

ilAssOrderingElementList	$correctness_true_element_list = null

bool	$interaction_enabled = true

bool	$nesting_enabled = true

bool	$styling_disabled = false

ilTemplate	$list_tpl = null

UIFactory	$ui_factory

UIRenderer	$ui_renderer

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 ilIdentifiedMultiValuesInputGUI
	getMultiValueSubFieldId ($identifier, $sub_field_index)

	getMultiValuePosIndexedFieldId ($identifier, $position_index)

	getMultiValuePosIndexedSubFieldId ($identifier, $sub_field_index, $position_index)

	getFieldIdFromPostVar ($temp_post_var)

	getPostVarSubField ($sub_field_index)

	getMultiValuePostVarSubField ($identifier, $sub_field_index)

	getMultiValuePostVarSubFieldPosIndexed ($identifier, $sub_field_index, $position_index)

	getMultiValuePostVarPosIndexed ($identifier, $positionIndex)

	getMultiValuePostVar ($identifier)

	buildMultiValueSubmitVar ($identifier, $position_index, $submit_cmd)

	setIdentifiedMultiValuesByArray ($a_values)

	prepareMultiValuesInput ($values)

	prepareMultiValuesSubmit ($values)

	getFormValuesManipulators ()

	addFormValuesManipulator (ilFormValuesManipulator $manipulator)

	getSubFieldCompletedPostVar ($subFieldIndex, $elem_post_var)

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)

Protected Attributes inherited from ilIdentifiedMultiValuesInputGUI
string	$element_add_cmd = self::ELEMENT_DEFAULT_ADD_CMD

string	$element_remove_cmd = self::ELEMENT_DEFAULT_REMOVE_CMD

string	$element_move_up_cmd = self::ELEMENT_DEFAULT_MOVE_UP_CMD

string	$element_move_down_cmd = self::ELEMENT_DEFAULT_MOVE_DOWN_CMD

	$identified_multi_values = []

	$formValuesManipulationChain = []

Protected Attributes inherited from ilTextInputGUI
	$value = null

int	$maxlength = 200

int	$size = 40

string	$validationRegexp = ""

string	$validationFailureMessage = ''

string	$suffix = ""

string	$style_css = ""

string	$css_class = ""

string	$ajax_datasource = ""

string	$ajax_datasource_delimiter = null

bool	$ajax_datasource_commit = false

string	$ajax_datasource_commit_url = ""

bool	$submit_form_on_enter = false

bool	$autocomplete_disabled = false

string	$input_type = ""

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

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 22 of file class.ilAssNestedOrderingElementsInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilAssNestedOrderingElementsInputGUI::__construct	(	ilAssOrderingFormValuesObjectsConverter	$converter,
			$postVar
	)

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

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

     {
         global $DIC;
         $this->ui_factory = $DIC['ui.factory'];
         $this->ui_renderer = $DIC['ui.renderer'];
         $manipulator = new ilAssOrderingDefaultElementFallback();
         $this->addFormValuesManipulator($manipulator);
 
         parent::__construct('', $postVar);
 
         $this->addFormValuesManipulator($converter);
     }

Here is the call graph for this function:

Member Function Documentation

◆ addIdentifierToValues()

ilAssNestedOrderingElementsInputGUI::addIdentifierToValues ( array $values )

private

Definition at line 326 of file class.ilAssNestedOrderingElementsInputGUI.php.

References assOrderingQuestionGUI\F_NESTED_IDENTIFIER_PREFIX.

Referenced by renderMainList().

                                                          : array
     {
         foreach (array_keys($values) as $k) {
             $values[$k]['identifier'] = str_replace(assOrderingQuestionGUI::F_NESTED_IDENTIFIER_PREFIX, '', $k);
         }
         return $values;
     }

Here is the caller graph for this function:

◆ buildHierarchicalTreeFromDBValues()

ilAssNestedOrderingElementsInputGUI::buildHierarchicalTreeFromDBValues ( array $values )

private

Definition at line 334 of file class.ilAssNestedOrderingElementsInputGUI.php.

References Vendor\Package\$a, and Vendor\Package\$b.

Referenced by renderMainList().

                                                                      : array
     {
         $values_with_parent = [];
         $levels_array = [];
         foreach ($values as $k => $v) {
             $v['parent'] = null;
             $v['children'] = [];
 
             if ($v['ordering_indentation'] > 0) {
                 $v['parent'] = $levels_array[$v['ordering_indentation'] - 1];
             }
             $levels_array[$v['ordering_indentation']] = $k;
             $values_with_parent[$k] = $v;
         }
 
         uasort(
             $values_with_parent,
             static fn(array $a, array $b): int => $b['ordering_indentation'] - $a['ordering_indentation']
         );
 
         foreach (array_keys($values_with_parent) as $k) {
             $v = $values_with_parent[$k];
             if ($v['parent'] !== null) {
                 $values_with_parent[$v['parent']]['children'][$k] = $v;
             }
         }
 
         return array_filter(
             $values_with_parent,
             static fn(array $v): bool => $v['ordering_indentation'] === 0
         );
     }

Here is the caller graph for this function:

◆ buildHTMLView()

ilAssNestedOrderingElementsInputGUI::buildHTMLView	(	array	$array,
		\Closure	$sort_closure
	)

private

Definition at line 367 of file class.ilAssNestedOrderingElementsInputGUI.php.

References $c, and renderListItem().

Referenced by renderMainList().

                                                                         : string
     {
         usort($array, $sort_closure);
         return array_reduce(
             $array,
             function (string $c, array $v) use ($sort_closure): string {
                 $children = '';
                 if ($this->nesting_enabled && $v['children'] !== []) {
                     $children = $this->buildHTMLView($v['children'], $sort_closure);
                 }
                 $c .= $this->renderListItem($v, $v['identifier'], $children);
                 return $c;
             },
             ''
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getContext()

ilAssNestedOrderingElementsInputGUI::getContext ( )

Definition at line 109 of file class.ilAssNestedOrderingElementsInputGUI.php.

References $context.

                                 : ?string
     {
         return $this->context;
     }

◆ getCorrectness()

ilAssNestedOrderingElementsInputGUI::getCorrectness ( int $identifier )

private

Definition at line 179 of file class.ilAssNestedOrderingElementsInputGUI.php.

References getCorrectnessTrueElementList().

Referenced by getItemHtml().

                                                     : bool
     {
         return $this->getCorrectnessTrueElementList()->elementExistByRandomIdentifier($identifier);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCorrectnessIcon()

ilAssNestedOrderingElementsInputGUI::getCorrectnessIcon ( $correctness )

private

Definition at line 184 of file class.ilAssNestedOrderingElementsInputGUI.php.

References $path, ilUtil\getImagePath(), and ILIAS\Repository\lng().

Referenced by getItemHtml().

                                                      : string
     {
         $icon_name = 'standard/icon_not_ok.svg';
         $label = $this->lng->txt("answer_is_wrong");
         if ($correctness === 'correct') {
             $icon_name = 'standard/icon_ok.svg';
             $label = $this->lng->txt("answer_is_right");
         }
         $path = ilUtil::getImagePath($icon_name);
         $icon = $this->ui_factory->symbol()->icon()->custom(
             $path,
             $label
         );
         return $this->ui_renderer->render($icon);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCorrectnessTrueElementList()

ilAssNestedOrderingElementsInputGUI::getCorrectnessTrueElementList ( )

Definition at line 169 of file class.ilAssNestedOrderingElementsInputGUI.php.

References $correctness_true_element_list.

Referenced by getCorrectness().

                                                    : ?ilAssOrderingElementList
     {
         return $this->correctness_true_element_list;
     }

Here is the caller graph for this function:

◆ getElementImagePath()

ilAssNestedOrderingElementsInputGUI::getElementImagePath ( )

Definition at line 144 of file class.ilAssNestedOrderingElementsInputGUI.php.

References $element_image_path.

Referenced by getThumbnailSource().

                                          : ?string
     {
         return $this->element_image_path;
     }

Here is the caller graph for this function:

◆ getElementList()

ilAssNestedOrderingElementsInputGUI::getElementList ( int $questionId )

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

References ilAssOrderingElementList\buildInstance(), and ilIdentifiedMultiValuesInputGUI\getIdentifiedMultiValues().

Referenced by prepareReprintable().

                                                    : ilAssOrderingElementList
     {
         return ilAssOrderingElementList::buildInstance($questionId, $this->getIdentifiedMultiValues());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getGlobalTpl()

ilAssNestedOrderingElementsInputGUI::getGlobalTpl ( )

private

Definition at line 78 of file class.ilAssNestedOrderingElementsInputGUI.php.

References $GLOBALS.

Referenced by initializePlayerJS(), and render().

     {
         return isset($GLOBALS['DIC']) ? $GLOBALS['DIC']['tpl'] : $GLOBALS['tpl'];
     }

Here is the caller graph for this function:

◆ getHTML()

ilAssNestedOrderingElementsInputGUI::getHTML ( )

Definition at line 402 of file class.ilAssNestedOrderingElementsInputGUI.php.

References render().

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

Here is the call graph for this function:

◆ getItemHtml()

ilAssNestedOrderingElementsInputGUI::getItemHtml	(	array	$element,
		string	$identifier,
		string	$content_post_var,
		string	$position_post_var,
		string	$indentation_post_var
	)

private

Definition at line 215 of file class.ilAssNestedOrderingElementsInputGUI.php.

References getCorrectness(), getCorrectnessIcon(), getItemTemplate(), getOrderingType(), getThumbnailFilename(), getThumbnailSource(), isShowCorrectnessIconsEnabled(), assOrderingQuestion\OQ_NESTED_PICTURES, assOrderingQuestion\OQ_NESTED_TERMS, assOrderingQuestion\OQ_PICTURES, assOrderingQuestion\OQ_TERMS, and ilLegacyFormElementsUtil\prepareFormOutput().

Referenced by renderListItem().

      : string {
         $tpl = $this->getItemTemplate();
 
         switch ($this->getOrderingType()) {
             case assOrderingQuestion::OQ_TERMS:
             case assOrderingQuestion::OQ_NESTED_TERMS:
 
                 $tpl->setCurrentBlock('item_text');
                 $tpl->setVariable('ITEM_CONTENT', ilLegacyFormElementsUtil::prepareFormOutput($element['content']));
                 $tpl->parseCurrentBlock();
                 break;
 
             case assOrderingQuestion::OQ_PICTURES:
             case assOrderingQuestion::OQ_NESTED_PICTURES:
 
                 $tpl->setCurrentBlock('item_image');
                 $tpl->setVariable('ITEM_SOURCE', $this->getThumbnailSource($element));
                 $tpl->setVariable('ITEM_CONTENT', $this->getThumbnailFilename($element));
                 $tpl->parseCurrentBlock();
                 break;
         }
 
         if ($this->isShowCorrectnessIconsEnabled()) {
             $correctness = 'not_correct';
             if ($this->getCorrectness($identifier)) {
                 $correctness = 'correct';
             }
             $tpl->setCurrentBlock('correctness_icon');
 
             $tpl->setVariable('ICON_OK', $this->getCorrectnessIcon($correctness));
             $tpl->parseCurrentBlock();
         }
 
         $tpl->setCurrentBlock('item');
         $tpl->setVariable('ITEM_CONTENT_POSTVAR', $content_post_var);
         $tpl->setVariable('ITEM_CONTENT', ilLegacyFormElementsUtil::prepareFormOutput($element['content']));
         $tpl->setVariable('ITEM_POSITION_POSTVAR', $position_post_var);
         $tpl->setVariable('ITEM_POSITION', $element['ordering_position']);
         $tpl->setVariable('ITEM_INDENTATION_POSTVAR', $indentation_post_var);
         $tpl->setVariable('ITEM_INDENTATION', $element['ordering_indentation']);
         $tpl->parseCurrentBlock();
 
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getItemTemplate()

ilAssNestedOrderingElementsInputGUI::getItemTemplate ( )

private

Definition at line 200 of file class.ilAssNestedOrderingElementsInputGUI.php.

Referenced by getItemHtml().

                                       : ilTemplate
     {
         return new ilTemplate('tpl.prop_ass_nested_order_elem.html', true, true, 'components/ILIAS/TestQuestionPool');
     }

Here is the caller graph for this function:

◆ getOrderingType()

ilAssNestedOrderingElementsInputGUI::getOrderingType ( )

Definition at line 134 of file class.ilAssNestedOrderingElementsInputGUI.php.

References $ordering_type.

Referenced by getItemHtml().

                                      : ?int
     {
         return $this->ordering_type;
     }

Here is the caller graph for this function:

◆ getThumbnailFilename()

ilAssNestedOrderingElementsInputGUI::getThumbnailFilename ( $element )

private

Definition at line 205 of file class.ilAssNestedOrderingElementsInputGUI.php.

References getThumbPrefix().

Referenced by getItemHtml(), and getThumbnailSource().

                                                    : string
     {
         return $this->getThumbPrefix() . $element['content'];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getThumbnailSource()

ilAssNestedOrderingElementsInputGUI::getThumbnailSource ( $element )

private

Definition at line 210 of file class.ilAssNestedOrderingElementsInputGUI.php.

References getElementImagePath(), and getThumbnailFilename().

Referenced by getItemHtml().

                                                  : string
     {
         return $this->getElementImagePath() . $this->getThumbnailFilename($element);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getThumbPrefix()

ilAssNestedOrderingElementsInputGUI::getThumbPrefix ( )

Definition at line 154 of file class.ilAssNestedOrderingElementsInputGUI.php.

References $thumbnail_filename_prefix.

Referenced by getThumbnailFilename().

                                     : string
     {
         return $this->thumbnail_filename_prefix;
     }

Here is the caller graph for this function:

◆ getUniquePrefix()

ilAssNestedOrderingElementsInputGUI::getUniquePrefix ( )

Definition at line 119 of file class.ilAssNestedOrderingElementsInputGUI.php.

References $unique_prefix.

                                      : int
     {
         return $this->unique_prefix;
     }

◆ initializePlayerJS()

ilAssNestedOrderingElementsInputGUI::initializePlayerJS ( )

private

Definition at line 407 of file class.ilAssNestedOrderingElementsInputGUI.php.

References getGlobalTpl().

Referenced by render().

                                          : void
     {
         $this->getGlobalTpl()->addJavascript('assets/js/orderingvertical.js');
         $this->getGlobalTpl()->addOnLoadCode(
             'il.test.orderingvertical.init(document.querySelector("#nestable_ordering"));'
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initListTemplate()

ilAssNestedOrderingElementsInputGUI::initListTemplate ( )

private

Definition at line 83 of file class.ilAssNestedOrderingElementsInputGUI.php.

Referenced by renderMainList().

                                        : void
     {
         $this->list_tpl = new ilTemplate('tpl.prop_nested_ordering_list.html', true, true, 'components/ILIAS/TestQuestionPool');
     }

Here is the caller graph for this function:

◆ isPostSubmit()

ilAssNestedOrderingElementsInputGUI::isPostSubmit ( $data )

Definition at line 266 of file class.ilAssNestedOrderingElementsInputGUI.php.

References $data, and ilFormPropertyGUI\getPostVar().

Referenced by assOrderingQuestion\getSolutionOrderingElementListForTestOutput().

                                        : bool
     {
         if (!is_array($data)) {
             return false;
         }
 
         if (!isset($data[$this->getPostVar()])) {
             return false;
         }
 
         if (!count($data[$this->getPostVar()])) {
             return false;
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isShowCorrectnessIconsEnabled()

ilAssNestedOrderingElementsInputGUI::isShowCorrectnessIconsEnabled ( )

Definition at line 164 of file class.ilAssNestedOrderingElementsInputGUI.php.

References $show_correctness_icons_enabled.

Referenced by getItemHtml().

                                                    : bool
     {
         return $this->show_correctness_icons_enabled;
     }

Here is the caller graph for this function:

◆ onCheckInput()

ilAssNestedOrderingElementsInputGUI::onCheckInput ( )

Definition at line 397 of file class.ilAssNestedOrderingElementsInputGUI.php.

                                   : bool
     {
         return true;
     }

◆ prepareReprintable()

ilAssNestedOrderingElementsInputGUI::prepareReprintable ( assQuestion $question )

Definition at line 98 of file class.ilAssNestedOrderingElementsInputGUI.php.

References getElementList(), assQuestion\getId(), and setElementList().

                                                              : void
     {
         $elementList = $this->getElementList($question->getId());
 
         $elementList->completeContentsFromElementList(
             $question->getOrderingElementList()
         );
 
         $this->setElementList($elementList);
     }

Here is the call graph for this function:

◆ render()

ilAssNestedOrderingElementsInputGUI::render ( string $a_mode = '' )

Definition at line 384 of file class.ilAssNestedOrderingElementsInputGUI.php.

References getGlobalTpl(), initializePlayerJS(), and renderMainList().

Referenced by getHTML().

                                                : string
     {
         if (!$this->styling_disabled) {
             $this->getGlobalTpl()->addCss('assets/css/content.css');
         }
 
         if ($this->interaction_enabled) {
             $this->initializePlayerJS();
         }
 
         return $this->renderMainList();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderListItem()

ilAssNestedOrderingElementsInputGUI::renderListItem	(	array	$value,
		string	$identifier,
		string	$children
	)

private

Definition at line 283 of file class.ilAssNestedOrderingElementsInputGUI.php.

References getItemHtml(), and ilIdentifiedMultiValuesInputGUI\getMultiValuePostVarSubField().

Referenced by buildHTMLView().

                                                                                        : string
     {
         $list_item_tpl = new ilTemplate('tpl.prop_nested_ordering_list_item.html', true, true, 'components/ILIAS/TestQuestionPool');
         $content_post_var = $this->getMultiValuePostVarSubField($identifier, self::POSTVAR_CONTENT);
         $position_post_var = $this->getMultiValuePostVarSubField($identifier, self::POSTVAR_POSITION);
         $indentation_post_var = $this->getMultiValuePostVarSubField($identifier, self::POSTVAR_INDENTATION);
 
         $list_item_tpl->setVariable('LIST_ITEM_VALUE', $this->getItemHtml(
             $value,
             $identifier,
             $content_post_var,
             $position_post_var,
             $indentation_post_var
         ));
 
         if ($this->nesting_enabled) {
             $list_item_tpl->setCurrentBlock('nested_list');
             $list_item_tpl->setVariable('SUB_LIST', $children);
             $list_item_tpl->parseCurrentBlock();
         }
         return $list_item_tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderMainList()

ilAssNestedOrderingElementsInputGUI::renderMainList ( )

private

Definition at line 306 of file class.ilAssNestedOrderingElementsInputGUI.php.

References Vendor\Package\$a, Vendor\Package\$b, addIdentifierToValues(), buildHierarchicalTreeFromDBValues(), buildHTMLView(), ilIdentifiedMultiValuesInputGUI\getIdentifiedMultiValues(), and initListTemplate().

Referenced by render().

                                      : string
     {
         $this->initListTemplate();
 
         $values = $this->addIdentifierToValues($this->getIdentifiedMultiValues());
         if ($this->nesting_enabled) {
             $values = $this->buildHierarchicalTreeFromDBValues($values);
         }
 
         $this->list_tpl->setVariable(
             'LIST_ITEMS',
             $this->buildHTMLView(
                 $values,
                 static fn(array $a, array $b): int => $a['ordering_position'] - $b['ordering_position']
             )
         );
 
         return $this->list_tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setContext()

ilAssNestedOrderingElementsInputGUI::setContext ( string $context )

Definition at line 114 of file class.ilAssNestedOrderingElementsInputGUI.php.

References $context.

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

◆ setCorrectnessTrueElementList()

ilAssNestedOrderingElementsInputGUI::setCorrectnessTrueElementList ( ilAssOrderingElementList $correctness_true_element_list )

Definition at line 174 of file class.ilAssNestedOrderingElementsInputGUI.php.

References $correctness_true_element_list.

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

◆ setElementImagePath()

ilAssNestedOrderingElementsInputGUI::setElementImagePath ( string $element_image_path )

Definition at line 139 of file class.ilAssNestedOrderingElementsInputGUI.php.

References $element_image_path.

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

◆ setElementList()

ilAssNestedOrderingElementsInputGUI::setElementList ( ilAssOrderingElementList $elementList )

Definition at line 88 of file class.ilAssNestedOrderingElementsInputGUI.php.

References ilAssOrderingElementList\getRandomIdentifierIndexedElements(), and ilIdentifiedMultiValuesInputGUI\setIdentifiedMultiValues().

Referenced by prepareReprintable().

                                                                          : void
     {
         $this->setIdentifiedMultiValues($elementList->getRandomIdentifierIndexedElements());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setInteractionEnabled()

ilAssNestedOrderingElementsInputGUI::setInteractionEnabled ( bool $interaction_enabled )

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

References $interaction_enabled.

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

◆ setNestingEnabled()

ilAssNestedOrderingElementsInputGUI::setNestingEnabled ( bool $nesting_enabled )

Definition at line 68 of file class.ilAssNestedOrderingElementsInputGUI.php.

References $nesting_enabled.

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

◆ setOrderingType()

ilAssNestedOrderingElementsInputGUI::setOrderingType ( int $ordering_type )

Definition at line 129 of file class.ilAssNestedOrderingElementsInputGUI.php.

References $ordering_type.

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

◆ setShowCorrectnessIconsEnabled()

ilAssNestedOrderingElementsInputGUI::setShowCorrectnessIconsEnabled ( bool $show_correctness_icons_enabled )

Definition at line 159 of file class.ilAssNestedOrderingElementsInputGUI.php.

References $show_correctness_icons_enabled.

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

◆ setStylingDisabled()

ilAssNestedOrderingElementsInputGUI::setStylingDisabled ( bool $styling_disabled )

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

References $styling_disabled.

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

◆ setThumbPrefix()

ilAssNestedOrderingElementsInputGUI::setThumbPrefix ( string $thumbnail_filename_prefix )

Definition at line 149 of file class.ilAssNestedOrderingElementsInputGUI.php.

References $thumbnail_filename_prefix.

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

◆ setUniquePrefix()

ilAssNestedOrderingElementsInputGUI::setUniquePrefix ( int $unique_prefix )

Definition at line 124 of file class.ilAssNestedOrderingElementsInputGUI.php.

References $unique_prefix.

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

Field Documentation

◆ $context

string ilAssNestedOrderingElementsInputGUI::$context = null

private

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

Referenced by getContext(), and setContext().

◆ $correctness_true_element_list

ilAssOrderingElementList ilAssNestedOrderingElementsInputGUI::$correctness_true_element_list = null

private

Definition at line 41 of file class.ilAssNestedOrderingElementsInputGUI.php.

Referenced by getCorrectnessTrueElementList(), and setCorrectnessTrueElementList().

◆ $element_image_path

string ilAssNestedOrderingElementsInputGUI::$element_image_path = null

private

Definition at line 39 of file class.ilAssNestedOrderingElementsInputGUI.php.

Referenced by getElementImagePath(), and setElementImagePath().

◆ $interaction_enabled

bool ilAssNestedOrderingElementsInputGUI::$interaction_enabled = true

private

Definition at line 42 of file class.ilAssNestedOrderingElementsInputGUI.php.

Referenced by setInteractionEnabled().

◆ $list_tpl

ilTemplate ilAssNestedOrderingElementsInputGUI::$list_tpl = null

private

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

◆ $nesting_enabled

bool ilAssNestedOrderingElementsInputGUI::$nesting_enabled = true

private

Definition at line 43 of file class.ilAssNestedOrderingElementsInputGUI.php.

Referenced by setNestingEnabled().

◆ $ordering_type

int ilAssNestedOrderingElementsInputGUI::$ordering_type = null

private

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

Referenced by getOrderingType(), and setOrderingType().

◆ $show_correctness_icons_enabled

bool ilAssNestedOrderingElementsInputGUI::$show_correctness_icons_enabled = false

private

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

Referenced by isShowCorrectnessIconsEnabled(), and setShowCorrectnessIconsEnabled().

◆ $styling_disabled

bool ilAssNestedOrderingElementsInputGUI::$styling_disabled = false

private

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

Referenced by setStylingDisabled().

◆ $thumbnail_filename_prefix

string ilAssNestedOrderingElementsInputGUI::$thumbnail_filename_prefix = self::DEFAULT_THUMBNAIL_PREFIX

private

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

Referenced by getThumbPrefix(), and setThumbPrefix().

◆ $ui_factory

UIFactory ilAssNestedOrderingElementsInputGUI::$ui_factory

private

Definition at line 47 of file class.ilAssNestedOrderingElementsInputGUI.php.

◆ $ui_renderer

UIRenderer ilAssNestedOrderingElementsInputGUI::$ui_renderer

private

Definition at line 48 of file class.ilAssNestedOrderingElementsInputGUI.php.

◆ $unique_prefix

int ilAssNestedOrderingElementsInputGUI::$unique_prefix = null

private

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

Referenced by getUniquePrefix(), and setUniquePrefix().

◆ CONTEXT_CORRECT_SOLUTION_PRESENTATION

const ilAssNestedOrderingElementsInputGUI::CONTEXT_CORRECT_SOLUTION_PRESENTATION = 'CorrectSolutionPresent'

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

Referenced by assOrderingQuestion\getSolutionOutputForLog(), and assOrderingQuestionGUI\renderSolutionOutput().

◆ CONTEXT_QUESTION_PREVIEW

const ilAssNestedOrderingElementsInputGUI::CONTEXT_QUESTION_PREVIEW = 'QuestionPreview'

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

Referenced by assOrderingQuestionGUI\getPreview().

◆ CONTEXT_USER_SOLUTION_PRESENTATION

const ilAssNestedOrderingElementsInputGUI::CONTEXT_USER_SOLUTION_PRESENTATION = 'UserSolutionPresent'

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

Referenced by assOrderingQuestionGUI\renderSolutionOutput().

◆ CONTEXT_USER_SOLUTION_SUBMISSION

const ilAssNestedOrderingElementsInputGUI::CONTEXT_USER_SOLUTION_SUBMISSION = 'UserSolutionSubmit'

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

Referenced by assOrderingQuestion\fetchSolutionListFromFormSubmissionData(), and assOrderingQuestionGUI\getTestOutput().

◆ DEFAULT_THUMBNAIL_PREFIX

const ilAssNestedOrderingElementsInputGUI::DEFAULT_THUMBNAIL_PREFIX = 'thumb.'

private

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

◆ POSTVAR_CONTENT

const ilAssNestedOrderingElementsInputGUI::POSTVAR_CONTENT = 'content'

private

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

◆ POSTVAR_INDENTATION

const ilAssNestedOrderingElementsInputGUI::POSTVAR_INDENTATION = 'indentation'

private

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

◆ POSTVAR_POSITION

const ilAssNestedOrderingElementsInputGUI::POSTVAR_POSITION = 'position'

private

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

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

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

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addIdentifierToValues()

◆ buildHierarchicalTreeFromDBValues()

◆ buildHTMLView()

◆ getContext()

◆ getCorrectness()

◆ getCorrectnessIcon()

◆ getCorrectnessTrueElementList()

◆ getElementImagePath()

◆ getElementList()

◆ getGlobalTpl()

◆ getHTML()

◆ getItemHtml()

◆ getItemTemplate()

◆ getOrderingType()

◆ getThumbnailFilename()

◆ getThumbnailSource()

◆ getThumbPrefix()

◆ getUniquePrefix()

◆ initializePlayerJS()

◆ initListTemplate()

◆ isPostSubmit()

◆ isShowCorrectnessIconsEnabled()

◆ onCheckInput()

◆ prepareReprintable()

◆ render()

◆ renderListItem()

◆ renderMainList()

◆ setContext()

◆ setCorrectnessTrueElementList()

◆ setElementImagePath()

◆ setElementList()

◆ setInteractionEnabled()

◆ setNestingEnabled()

◆ setOrderingType()

◆ setShowCorrectnessIconsEnabled()

◆ setStylingDisabled()

◆ setThumbPrefix()

◆ setUniquePrefix()

Field Documentation

◆ $context

◆ $correctness_true_element_list

◆ $element_image_path

◆ $interaction_enabled

◆ $list_tpl

◆ $nesting_enabled

◆ $ordering_type

◆ $show_correctness_icons_enabled

◆ $styling_disabled

◆ $thumbnail_filename_prefix

◆ $ui_factory

◆ $ui_renderer

◆ $unique_prefix

◆ CONTEXT_CORRECT_SOLUTION_PRESENTATION

◆ CONTEXT_QUESTION_PREVIEW

◆ CONTEXT_USER_SOLUTION_PRESENTATION

◆ CONTEXT_USER_SOLUTION_SUBMISSION

◆ DEFAULT_THUMBNAIL_PREFIX

◆ POSTVAR_CONTENT

◆ POSTVAR_INDENTATION

◆ POSTVAR_POSITION