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

Inheritance diagram for ilMatrixRowWizardInputGUI:

Collaboration diagram for ilMatrixRowWizardInputGUI:

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

	getUseOtherAnswer ()

	setUseOtherAnswer (bool $a_value)

	setValue ($a_value)

	setValues (SurveyCategories $a_values)

	getValues ()

	setAllowMove (bool $a_allow_move)

	getAllowMove ()

	setShowWizard (bool $a_value)

	getShowWizard ()

	setCategoryText (string $a_text)

	getCategoryText ()

	setLabelText (string $a_text)

	getLabelText ()

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

	getInput ()

	insert (ilTemplate $a_tpl)

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
ILIAS Survey InternalGUIService	$gui

ilGlobalTemplateInterface	$tpl

SurveyCategories	$values = null

bool	$allowMove = false

bool	$show_wizard = false

string	$categorytext

string	$labeltext

bool	$use_other_answer

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 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 survey question category wizard property in a property form.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilMatrixRowWizardInputGUI::__construct	(	string	$a_title = `""`,
		string	$a_postvar = `""`
	)

Reimplemented from ilTextInputGUI.

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

      {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->tpl = $DIC["tpl"];
        $lng = $DIC->language();
 
        parent::__construct($a_title, $a_postvar);
 
        $this->show_wizard = false;
        $this->categorytext = $lng->txt('row_text');
        $this->use_other_answer = false;
        $this->values = new SurveyCategories();
 
        $this->setMaxLength(1000); // #6803
        $this->gui = $DIC->survey()->internal()->gui();
    }

References $DIC, ilFormPropertyGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), ilTextInputGUI\setMaxLength(), and ilLanguage\txt().

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilMatrixRowWizardInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Reimplemented from ilTextInputGUI.

Definition at line 132 of file class.ilMatrixRowWizardInputGUI.php.

                                : bool
    {
        $lng = $this->lng;
        $foundvalues = $this->getInput();
        if (count($foundvalues) > 0) {
            // check answers
            if (is_array($foundvalues['answer'] ?? null)) {
                foreach ($foundvalues['answer'] as $idx => $answervalue) {
                    if ((strlen((string) ($answervalue ?? "")) === 0) && ($this->getRequired() && (!(bool) ($foundvalues['other'][$idx] ?? false)))) {
                        $this->setAlert($lng->txt("msg_input_is_required"));
                        return false;
                    }
                }
            }
        } else {
            $this->setAlert($lng->txt("msg_input_is_required"));
            return false;
        }
 
        return $this->checkSubItemsInput();
    }

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

Here is the call graph for this function:

◆ getAllowMove()

ilMatrixRowWizardInputGUI::getAllowMove ( )

Definition at line 96 of file class.ilMatrixRowWizardInputGUI.php.

                                  : bool
    {
        return $this->allowMove;
    }

References $allowMove.

Referenced by insert().

Here is the caller graph for this function:

◆ getCategoryText()

ilMatrixRowWizardInputGUI::getCategoryText ( )

Definition at line 116 of file class.ilMatrixRowWizardInputGUI.php.

                                     : string
    {
        return $this->categorytext;
    }

References $categorytext.

Referenced by insert().

Here is the caller graph for this function:

◆ getInput()

ilMatrixRowWizardInputGUI::getInput ( )

Returns: string|string[]

Reimplemented from ilTextInputGUI.

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

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

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

Referenced by checkInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLabelText()

ilMatrixRowWizardInputGUI::getLabelText ( )

Definition at line 126 of file class.ilMatrixRowWizardInputGUI.php.

                                  : string
    {
        return $this->labeltext;
    }

References $labeltext.

Referenced by insert().

Here is the caller graph for this function:

◆ getShowWizard()

ilMatrixRowWizardInputGUI::getShowWizard ( )

Definition at line 106 of file class.ilMatrixRowWizardInputGUI.php.

                                   : bool
    {
        return $this->show_wizard;
    }

References $show_wizard.

◆ getUseOtherAnswer()

ilMatrixRowWizardInputGUI::getUseOtherAnswer ( )

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

                                       : bool
    {
        return $this->use_other_answer;
    }

References $use_other_answer.

Referenced by insert().

Here is the caller graph for this function:

◆ getValues()

ilMatrixRowWizardInputGUI::getValues ( )

Definition at line 86 of file class.ilMatrixRowWizardInputGUI.php.

                               : SurveyCategories
    {
        return $this->values;
    }

References $values.

◆ insert()

ilMatrixRowWizardInputGUI::insert ( ilTemplate $a_tpl )

Reimplemented from ilTextInputGUI.

Definition at line 161 of file class.ilMatrixRowWizardInputGUI.php.

                                             : void
    {
        $lng = $this->lng;
 
        $tpl = new ilTemplate("tpl.prop_matrixrowwizardinput.html", true, true, "components/ILIAS/SurveyQuestionPool");
        if (is_object($this->values)) {
            for ($i = 0; $i < $this->values->getCategoryCount(); $i++) {
                $cat = $this->values->getCategory($i);
                $tpl->setCurrentBlock("prop_text_propval");
                $tpl->setVariable("PROPERTY_VALUE", ilLegacyFormElementsUtil::prepareFormOutput((string) $cat->title));
                $tpl->parseCurrentBlock();
                $tpl->setCurrentBlock("prop_label_propval");
                $tpl->setVariable("PROPERTY_VALUE", ilLegacyFormElementsUtil::prepareFormOutput((string) $cat->label));
                $tpl->parseCurrentBlock();
 
                if ($this->getUseOtherAnswer()) {
                    $tpl->setCurrentBlock("other_answer_checkbox");
                    $tpl->setVariable("POST_VAR", $this->getPostVar());
                    $tpl->setVariable("OTHER_ID", $this->getPostVar() . "[other][$i]");
                    $tpl->setVariable("ROW_NUMBER", $i);
                    if ($cat->other) {
                        $tpl->setVariable("CHECKED_OTHER", ' checked="checked"');
                    }
                    $tpl->parseCurrentBlock();
                }
 
                if ($this->getAllowMove()) {
                    $tpl->setCurrentBlock("move");
                    $tpl->setVariable("CMD_UP", "cmd[up" . $this->getFieldId() . "][$i]");
                    $tpl->setVariable("CMD_DOWN", "cmd[down" . $this->getFieldId() . "][$i]");
                    $tpl->setVariable("ID", $this->getPostVar() . "[$i]");
                    $tpl->setVariable("UP_BUTTON", $this->gui->symbol()->glyph("up")->render());
                    $tpl->setVariable("DOWN_BUTTON", $this->gui->symbol()->glyph("down")->render());
                    $tpl->parseCurrentBlock();
                }
 
                $tpl->setCurrentBlock("row");
                $tpl->setVariable("POST_VAR", $this->getPostVar());
                $tpl->setVariable("ROW_NUMBER", $i);
                $tpl->setVariable("ID", $this->getPostVar() . "[answer][$i]");
                $tpl->setVariable("ID_LABEL", $this->getPostVar() . "[label][$i]");
                $tpl->setVariable("SIZE", $this->getSize());
                $tpl->setVariable("SIZE_LABEL", 15);
                $tpl->setVariable("MAXLENGTH", $this->getMaxLength());
                if ($this->getDisabled()) {
                    $tpl->setVariable("DISABLED", " disabled=\"disabled\"");
                    $tpl->setVariable("DISABLED_LABEL", " disabled=\"disabled\"");
                }
 
                $tpl->setVariable("CMD_ADD", "cmd[add" . $this->getFieldId() . "][$i]");
                $tpl->setVariable("CMD_REMOVE", "cmd[remove" . $this->getFieldId() . "][$i]");
                $tpl->setVariable("ADD_BUTTON", $this->gui->symbol()->glyph("add")->render());
                $tpl->setVariable("REMOVE_BUTTON", $this->gui->symbol()->glyph("remove")->render());
                $tpl->parseCurrentBlock();
            }
        }
 
        if ($this->getUseOtherAnswer()) {
            $tpl->setCurrentBlock('other_answer_title');
            $tpl->setVariable("OTHER_TEXT", $lng->txt('use_other_answer'));
            $tpl->parseCurrentBlock();
        }
 
        $tpl->setVariable("ELEMENT_ID", $this->getPostVar());
        $tpl->setVariable("ANSWER_TEXT", $this->getCategoryText());
        $tpl->setVariable("LABEL_TEXT", $this->getLabelText());
        $tpl->setVariable("ACTIONS_TEXT", $lng->txt('actions'));
 
        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $tpl->get());
        $a_tpl->parseCurrentBlock();
 
        $tpl = $this->tpl;
        $tpl->addJavaScript("assets/js/ServiceFormWizardInput.js");
        $tpl->addJavaScript("assets/js/matrixrowwizard.js");
    }

References ilFormPropertyGUI\$lng, $tpl, ILIAS\UICore\GlobalTemplate\addJavaScript(), ILIAS\UICore\GlobalTemplate\get(), getAllowMove(), getCategoryText(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), getLabelText(), ilTextInputGUI\getMaxLength(), ilFormPropertyGUI\getPostVar(), ilTextInputGUI\getSize(), getUseOtherAnswer(), ILIAS\UICore\GlobalTemplate\parseCurrentBlock(), ilTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareFormOutput(), ilTemplate\setCurrentBlock(), ILIAS\UICore\GlobalTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), ILIAS\UICore\GlobalTemplate\setVariable(), and ilLanguage\txt().

Here is the call graph for this function:

◆ setAllowMove()

ilMatrixRowWizardInputGUI::setAllowMove ( bool $a_allow_move )

Definition at line 91 of file class.ilMatrixRowWizardInputGUI.php.

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

◆ setCategoryText()

ilMatrixRowWizardInputGUI::setCategoryText ( string $a_text )

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

                                                   : void
    {
        $this->categorytext = $a_text;
    }

◆ setLabelText()

ilMatrixRowWizardInputGUI::setLabelText ( string $a_text )

Definition at line 121 of file class.ilMatrixRowWizardInputGUI.php.

                                                : void
    {
        $this->labeltext = $a_text;
    }

◆ setShowWizard()

ilMatrixRowWizardInputGUI::setShowWizard ( bool $a_value )

Definition at line 101 of file class.ilMatrixRowWizardInputGUI.php.

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

◆ setUseOtherAnswer()

ilMatrixRowWizardInputGUI::setUseOtherAnswer ( bool $a_value )

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

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

◆ setValue()

ilMatrixRowWizardInputGUI::setValue ( $a_value )

Parameters

string | array $a_value

Reimplemented from ilTextInputGUI.

Definition at line 71 of file class.ilMatrixRowWizardInputGUI.php.

                                      : void
    {
        $this->values = new SurveyCategories();
        if (is_array($a_value) && is_array($a_value['answer'] ?? null)) {
            foreach ($a_value['answer'] as $index => $value) {
                $this->values->addCategory((string) $value, (int) ($a_value['other'][$index] ?? 0));
            }
        }
    }

References ilTextInputGUI\$value.

◆ setValues()

ilMatrixRowWizardInputGUI::setValues ( SurveyCategories $a_values )

Definition at line 81 of file class.ilMatrixRowWizardInputGUI.php.

                                                         : void
    {
        $this->values = $a_values;
    }

Field Documentation

◆ $allowMove

bool ilMatrixRowWizardInputGUI::$allowMove = false

protected

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

Referenced by getAllowMove().

◆ $categorytext

string ilMatrixRowWizardInputGUI::$categorytext

protected

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

Referenced by getCategoryText().

◆ $gui

ILIAS Survey InternalGUIService ilMatrixRowWizardInputGUI::$gui

protected

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

◆ $labeltext

string ilMatrixRowWizardInputGUI::$labeltext

protected

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

Referenced by getLabelText().

◆ $show_wizard

bool ilMatrixRowWizardInputGUI::$show_wizard = false

protected

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

Referenced by getShowWizard().

◆ $tpl

ilGlobalTemplateInterface ilMatrixRowWizardInputGUI::$tpl

protected

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

Referenced by insert().

◆ $use_other_answer

bool ilMatrixRowWizardInputGUI::$use_other_answer

protected

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

Referenced by getUseOtherAnswer().

◆ $values

SurveyCategories ilMatrixRowWizardInputGUI::$values = null

protected

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

Referenced by getValues().

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

components/ILIAS/SurveyQuestionPool/classes/class.ilMatrixRowWizardInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getAllowMove()

◆ getCategoryText()

◆ getInput()

◆ getLabelText()

◆ getShowWizard()

◆ getUseOtherAnswer()

◆ getValues()

◆ insert()

◆ setAllowMove()

◆ setCategoryText()

◆ setLabelText()

◆ setShowWizard()

◆ setUseOtherAnswer()

◆ setValue()

◆ setValues()

Field Documentation

◆ $allowMove

◆ $categorytext

◆ $gui

◆ $labeltext

◆ $show_wizard

◆ $tpl

◆ $use_other_answer

◆ $values