This class represents a key value pair wizard property in a property form. More...

Inheritance diagram for ilMatchingPairWizardInputGUI:

Collaboration diagram for ilMatchingPairWizardInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	setValue ($a_value)

	setTerms ($a_terms)
	Set terms. More...

	setDefinitions ($a_definitions)
	Set definitions. More...

	setPairs ($a_pairs)
	Set pairs. More...

	setAllowMove ($a_allow_move)
	Set allow move. More...

	getAllowMove ()
	Get allow move. More...

	checkInput ()
	Check input, strip slashes etc. More...

	insert (ilTemplate $a_tpl)
	Insert property html. More...

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 ()
	Check input, strip slashes etc. More...

	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)
	Get item by post var. More...

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
	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...

	getTableFilterLabelFor ()
	Get label "for" attribute value. More...

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

Protected Attributes
	$pairs = []

	$allowMove = false

	$terms = []

	$definitions = []

ilTestLegacyFormsHelper	$forms_helper

GlyphFactory	$glyph_factory

ButtonFactory	$button_factory

Renderer	$renderer

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

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 class represents a key value pair wizard property in a property form.

Author: Helmut Schottmüller ilias.nosp@m.@aur.nosp@m.ealis.nosp@m..de

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilMatchingPairWizardInputGUI::__construct	(	$a_title = `""`,
		$a_postvar = `""`
	)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

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

    {
        parent::__construct($a_title, $a_postvar);
 
        global $DIC;
 
        $this->forms_helper = new ilTestLegacyFormsHelper();
        $this->glyph_factory = $DIC->ui()->factory()->symbol()->glyph();
        $this->button_factory = $DIC->ui()->factory()->button();
        $this->renderer = $DIC->ui()->renderer();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilMatchingPairWizardInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

Reimplemented from ilTextInputGUI.

Reimplemented in ilAssMatchingPairCorrectionsInputGUI.

Definition at line 146 of file class.ilMatchingPairWizardInputGUI.php.

                                : bool
    {
        $to_int = $this->refinery->kindlyTo()->int();
        $data = $this->raw($this->getPostVar());
 
        if (!is_array($data)) {
            $this->setAlert($this->lng->txt('msg_input_is_required'));
            return false;
        }
 
        // check points
        $result_points = $this->forms_helper->checkPointsInputEnoughPositive($data, true);
        if (!is_array($result_points)) {
            $this->setAlert($this->lng->txt($result_points));
            return false;
        }
 
        // check answers
        $terms = $this->forms_helper->transformArray($data, 'term', $to_int);
        $definitions = $this->forms_helper->transformArray($data, 'definition', $to_int);
        foreach ([$terms, $definitions] as $value) {
            if ($value < 1 && $this->getRequired()) {
                $this->setAlert($this->lng->txt('msg_input_is_required'));
                return false;
            }
        }
 
        return $this->checkSubItemsInput();
    }

References $data, $definitions, $terms, ilTextInputGUI\$value, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ILIAS\Repository\lng(), ilFormPropertyGUI\raw(), ILIAS\Repository\refinery(), and ilFormPropertyGUI\setAlert().

Here is the call graph for this function:

◆ getAllowMove()

ilMatchingPairWizardInputGUI::getAllowMove ( )

Get allow move.

Returns: boolean Allow move

Definition at line 137 of file class.ilMatchingPairWizardInputGUI.php.

                                  : bool
    {
        return $this->allowMove;
    }

References $allowMove.

Referenced by insert().

Here is the caller graph for this function:

◆ insert()

ilMatchingPairWizardInputGUI::insert ( ilTemplate $a_tpl )

Insert property html.

Returns: void Size

Reimplemented from ilTextInputGUI.

Reimplemented in ilAssMatchingPairCorrectionsInputGUI.

Definition at line 180 of file class.ilMatchingPairWizardInputGUI.php.

                                             : void
    {
        global $DIC;
        $lng = $DIC['lng'];
        $global_tpl = $DIC['tpl'];
        $global_tpl->addJavascript("assets/js/answerwizardinput.js");
        $global_tpl->addJavascript("assets/js/matchingpairwizard.js");
 
        $tpl = new ilTemplate("tpl.prop_matchingpairinput.html", true, true, "components/ILIAS/TestQuestionPool");
        $i = 0;
 
        foreach ($this->pairs as $pair) {
            $counter = 1;
            $tpl->setCurrentBlock("option_term");
            $tpl->setVariable("TEXT_OPTION", ilLegacyFormElementsUtil::prepareFormOutput($lng->txt('please_select')));
            $tpl->setVariable("VALUE_OPTION", 0);
            $tpl->parseCurrentBlock();
            foreach ($this->terms as $term) {
                $tpl->setCurrentBlock("option_term");
                $tpl->setVariable("VALUE_OPTION", ilLegacyFormElementsUtil::prepareFormOutput($term->getIdentifier()));
                $tpl->setVariable("TEXT_OPTION", $lng->txt('term') . " " . $counter);
                if ($pair->getTerm()->getIdentifier() == $term->getIdentifier()) {
                    $tpl->setVariable('SELECTED_OPTION', ' selected="selected"');
                }
                $tpl->parseCurrentBlock();
                $counter++;
            }
            $counter = 1;
            $tpl->setCurrentBlock("option_definition");
            $tpl->setVariable("TEXT_OPTION", ilLegacyFormElementsUtil::prepareFormOutput($lng->txt('please_select')));
            $tpl->setVariable("VALUE_OPTION", 0);
            $tpl->parseCurrentBlock();
            foreach ($this->definitions as $definition) {
                $tpl->setCurrentBlock("option_definition");
                $tpl->setVariable("VALUE_OPTION", ilLegacyFormElementsUtil::prepareFormOutput($definition->getIdentifier()));
                $tpl->setVariable("TEXT_OPTION", $lng->txt('definition') . " " . $counter);
                if ($pair->getDefinition()->getIdentifier() == $definition->getIdentifier()) {
                    $tpl->setVariable('SELECTED_OPTION', ' selected="selected"');
                }
                $tpl->parseCurrentBlock();
                $counter++;
            }
 
 
            $tpl->setCurrentBlock('points_value');
            $tpl->setVariable('POINTS_VALUE', $pair->getPoints());
            $tpl->parseCurrentBlock();
 
            if ($this->getAllowMove()) {
                $tpl->setCurrentBlock("move");
                $tpl->setVariable("ID", $this->getPostVar() . "[$i]");
                $tpl->setVariable("UP_BUTTON", $this->renderer->render(
                    $this->button_factory->shy('', '')->withSymbol($this->glyph_factory->up())
                ));
                $tpl->setVariable("DOWN_BUTTON", $this->renderer->render(
                    $this->button_factory->shy('', '')->withSymbol($this->glyph_factory->down())
                ));
                $tpl->parseCurrentBlock();
            }
 
            $tpl->setCurrentBlock("row");
            $tpl->setVariable("ROW_NUMBER", $i);
 
            $tpl->setVariable("ID", $this->getPostVar() . "[$i]");
            $tpl->setVariable("ADD_BUTTON", $this->renderer->render(
                $this->button_factory->shy('', '')->withSymbol($this->glyph_factory->add())
            ));
            $tpl->setVariable("REMOVE_BUTTON", $this->renderer->render(
                $this->button_factory->shy('', '')->withSymbol($this->glyph_factory->remove())
            ));
 
            $tpl->setVariable("POST_VAR", $this->getPostVar());
 
            $tpl->parseCurrentBlock();
 
            $i++;
        }
 
        $tpl->setCurrentBlock('term_ids');
        $ids = [];
        foreach ($this->terms as $term) {
            array_push($ids, $term->getIdentifier());
        }
        $tpl->setVariable("POST_VAR", $this->getPostVar());
        $tpl->setVariable("TERM_IDS", join(",", $ids));
        $tpl->parseCurrentBlock();
 
        $tpl->setCurrentBlock('definition_ids');
        $ids = [];
        foreach ($this->definitions as $definition) {
            array_push($ids, $definition->getIdentifier());
        }
        $tpl->setVariable("POST_VAR", $this->getPostVar());
        $tpl->setVariable("DEFINITION_IDS", join(",", $ids));
        $tpl->parseCurrentBlock();
 
        $tpl->setVariable("ELEMENT_ID", $this->getPostVar());
        $tpl->setVariable("TEXT_POINTS", $lng->txt('points'));
        $tpl->setVariable("TEXT_DEFINITION", $lng->txt('definition'));
        $tpl->setVariable("TEXT_TERM", $lng->txt('term'));
        $tpl->setVariable("TEXT_ACTIONS", $lng->txt('actions'));
 
        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $tpl->get());
        $a_tpl->parseCurrentBlock();
    }

References $counter, $DIC, ilFormPropertyGUI\$global_tpl, ilFormPropertyGUI\$lng, getAllowMove(), ilFormPropertyGUI\getPostVar(), ilTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareFormOutput(), renderer(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilLanguage\txt().

Here is the call graph for this function:

◆ setAllowMove()

ilMatchingPairWizardInputGUI::setAllowMove ( $a_allow_move )

Set allow move.

Parameters

boolean $a_allow_move Allow move

Definition at line 127 of file class.ilMatchingPairWizardInputGUI.php.

                                               : void
    {
        $this->allowMove = $a_allow_move;
    }

◆ setDefinitions()

ilMatchingPairWizardInputGUI::setDefinitions ( $a_definitions )

Set definitions.

Parameters

array $a_definitions Definitions

Definition at line 107 of file class.ilMatchingPairWizardInputGUI.php.

                                                  : void
    {
        $this->definitions = $a_definitions;
    }

◆ setPairs()

ilMatchingPairWizardInputGUI::setPairs ( $a_pairs )

Set pairs.

Parameters

array $a_pairs Pairs

Definition at line 117 of file class.ilMatchingPairWizardInputGUI.php.

                                      : void
    {
        $this->pairs = $a_pairs;
    }

◆ setTerms()

ilMatchingPairWizardInputGUI::setTerms ( $a_terms )

Set terms.

Parameters

array $a_terms Terms

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

                                      : void
    {
        $this->terms = $a_terms;
    }

◆ setValue()

ilMatchingPairWizardInputGUI::setValue ( $a_value )

Parameters

string | array $a_value

Reimplemented from ilTextInputGUI.

Reimplemented in ilAssMatchingPairCorrectionsInputGUI.

Definition at line 62 of file class.ilMatchingPairWizardInputGUI.php.

                                      : void
    {
        $this->pairs = [];
        $this->terms = [];
        $this->definitions = [];
 
        $to_int = $this->refinery->kindlyTo()->int();
        $points = $this->forms_helper->transformPoints($a_value);
        $terms = $this->forms_helper->transformArray($a_value, 'term', $to_int);
        $definitions = $this->forms_helper->transformArray($a_value, 'definition', $to_int);
 
        foreach ($terms as $index => $term) {
            $this->pairs[] = new assAnswerMatchingPair(
                new assAnswerMatchingTerm('', '', $term),
                new assAnswerMatchingDefinition('', '', $definitions[$index] ?? 0),
                $points[$index]
            );
        }
 
        $term_ids = explode(',', $a_value['term_id']);
        foreach ($term_ids as $id) {
            $this->terms[] = new assAnswerMatchingTerm('', '', (int) $id);
        }
 
        $definition_ids = explode(',', $a_value['definition_id']);
        foreach ($definition_ids as $id) {
            $this->definitions[] = new assAnswerMatchingDefinition('', '', (int) $id);
        }
    }