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

Inheritance diagram for ilSuggestedSolutionSelectorGUI:

Collaboration diagram for ilSuggestedSolutionSelectorGUI:

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

	setOptions ($a_options)
	Set Options. More...

	getOptions ()
	Get Options. More...

	setValue ($a_value)
	Set Value. More...

	getValue ()
	Get Value. More...

	setInternalLink ($a_value)
	Set internal link. More...

	getInternalLink ()
	Get internal linnk. More...

	setInternalLinkText ($a_value)
	Set internal link.text. More...

	getInternalLinkText ()
	Get internal link text. More...

	setAddCommand ($a_add_command)
	Set add command. More...

	getAddCommand ()
	Get add command. More...

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

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

	insert ($a_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)
	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...

Protected Attributes
	$options

	$value

	$addCommand

	$intlink

	$intlinktext

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 selection list property in a property form.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

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

    {
        parent::__construct($a_title, $a_postvar);
        $this->setType("select");
    }

References ILIAS\GlobalScreen\Provider\__construct(), and ilFormPropertyGUI\setType().

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilSuggestedSolutionSelectorGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

Reimplemented from ilFormPropertyGUI.

Definition at line 160 of file class.ilSuggestedSolutionSelectorGUI.php.

                                : bool
    {
        if ($this->getRequired() && $this->str($this->getPostVar()) === '') {
            $this->setAlert($this->lng->txt('msg_input_is_required'));
            return false;
        }
 
        return $this->checkSubItemsInput();
    }

References ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ILIAS\Repository\lng(), ilFormPropertyGUI\setAlert(), and ilFormPropertyGUI\str().

Here is the call graph for this function:

◆ getAddCommand()

ilSuggestedSolutionSelectorGUI::getAddCommand ( )

Get add command.

Returns: string add command

Definition at line 141 of file class.ilSuggestedSolutionSelectorGUI.php.

                                   : string
    {
        return ($this->addCommand) ? $this->addCommand : "addInternalLink";
    }

Referenced by insert().

Here is the caller graph for this function:

◆ getInternalLink()

ilSuggestedSolutionSelectorGUI::getInternalLink ( )

Get internal linnk.

Returns: string Internal link

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

                                     : string
    {
        return $this->intlink;
    }

References $intlink.

Referenced by insert().

Here is the caller graph for this function:

◆ getInternalLinkText()

ilSuggestedSolutionSelectorGUI::getInternalLinkText ( )

Get internal link text.

Returns: string Internal link text

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

                                         : string
    {
        return $this->intlinktext;
    }

References $intlinktext.

Referenced by insert().

Here is the caller graph for this function:

◆ getOptions()

ilSuggestedSolutionSelectorGUI::getOptions ( )

Get Options.

Returns: array Options. Array ("value" => "option_text")

Definition at line 61 of file class.ilSuggestedSolutionSelectorGUI.php.

                                : array
    {
        return $this->options;
    }

References $options.

Referenced by insert().

Here is the caller graph for this function:

◆ getValue()

ilSuggestedSolutionSelectorGUI::getValue ( )

Get Value.

Returns: string Value

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

                              : string
    {
        return $this->value;
    }

References $value.

Referenced by insert().

Here is the caller graph for this function:

◆ insert()

ilSuggestedSolutionSelectorGUI::insert ( $a_tpl )

Definition at line 170 of file class.ilSuggestedSolutionSelectorGUI.php.

                                  : void
    {
        $template = new ilTemplate("tpl.prop_suggestedsolutionselector.html", true, true, "components/ILIAS/TestQuestionPool");
 
        foreach ($this->getOptions() as $option_value => $option_text) {
            $template->setCurrentBlock("prop_intlink_select_option");
            $template->setVariable("VAL_SELECT_OPTION", $option_value);
            if ($option_value == $this->getValue()) {
                $template->setVariable(
                    "CHK_SEL_OPTION",
                    'selected="selected"'
                );
            }
            $template->setVariable("TXT_SELECT_OPTION", $option_text);
            $template->parseCurrentBlock();
        }
        if ($this->getInternalLink()) {
            $template->setCurrentBlock("delete_internallink");
            $template->setVariable("TEXT_DELETE_INTERNALLINK", $this->lng->txt("remove_solution"));
            $template->setVariable("POST_VAR", $this->getPostVar());
            $template->parseCurrentBlock();
            $template->setCurrentBlock("internal_link");
            $template->setVariable("HREF_INT_LINK", $this->getInternalLink());
            $template->setVariable("TEXT_INT_LINK", $this->getInternalLinkText());
            $template->parseCurrentBlock();
        }
        $template->setCurrentBlock("prop_internallink_selector");
        $template->setVariable("POST_VAR", $this->getPostVar());
        if ($this->getDisabled()) {
            $template->setVariable(
                "DISABLED",
                " disabled=\"disabled\""
            );
        }
        $template->setVariable(
            "TEXT_ADD_INTERNALLINK",
            ($this->getInternalLink()) ? $this->lng->txt("change") : $this->lng->txt("add")
        );
        $template->setVariable("CMD_ADD_INTERNALLINK", $this->getAddCommand());
        $template->parseCurrentBlock();
        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $template->get());
        $a_tpl->parseCurrentBlock();
    }

References getAddCommand(), ilFormPropertyGUI\getDisabled(), getInternalLink(), getInternalLinkText(), getOptions(), ilFormPropertyGUI\getPostVar(), getValue(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ setAddCommand()

ilSuggestedSolutionSelectorGUI::setAddCommand ( $a_add_command )

Set add command.

Parameters

string $a_add_command add command

Definition at line 131 of file class.ilSuggestedSolutionSelectorGUI.php.

                                                 : void
    {
        $this->addCommand = $a_add_command;
    }

◆ setInternalLink()

ilSuggestedSolutionSelectorGUI::setInternalLink ( $a_value )

Set internal link.

Parameters

string $a_value Value

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

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

◆ setInternalLinkText()

ilSuggestedSolutionSelectorGUI::setInternalLinkText ( $a_value )

Set internal link.text.

Parameters

string $a_value Internal link text

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

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

◆ setOptions()

ilSuggestedSolutionSelectorGUI::setOptions ( $a_options )

Set Options.

Parameters

array $a_options Options. Array ("value" => "option_text")

Definition at line 51 of file class.ilSuggestedSolutionSelectorGUI.php.

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

◆ setValue()

ilSuggestedSolutionSelectorGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

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

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

Referenced by setValueByArray().

Here is the caller graph for this function:

◆ setValueByArray()

ilSuggestedSolutionSelectorGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

Definition at line 151 of file class.ilSuggestedSolutionSelectorGUI.php.

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

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

Here is the call graph for this function:

Field Documentation

◆ $addCommand

ilSuggestedSolutionSelectorGUI::$addCommand

protected

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

◆ $intlink

ilSuggestedSolutionSelectorGUI::$intlink

protected

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

Referenced by getInternalLink().

◆ $intlinktext

ilSuggestedSolutionSelectorGUI::$intlinktext

protected

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

Referenced by getInternalLinkText().

◆ $options

ilSuggestedSolutionSelectorGUI::$options

protected

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

Referenced by getOptions().

◆ $value

ilSuggestedSolutionSelectorGUI::$value

protected

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

Referenced by getValue().

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

components/ILIAS/TestQuestionPool/classes/class.ilSuggestedSolutionSelectorGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getAddCommand()

◆ getInternalLink()

◆ getInternalLinkText()

◆ getOptions()

◆ getValue()

◆ insert()

◆ setAddCommand()

◆ setInternalLink()

◆ setInternalLinkText()

◆ setOptions()

◆ setValue()

◆ setValueByArray()

Field Documentation

◆ $addCommand

◆ $intlink

◆ $intlinktext

◆ $options

◆ $value