This class represents a selection list property in a property form. 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)
	Insert property html. More...

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem ($a_item)
	Add Subitem. More...

	getSubItems ()
	Get Subitems. More...

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

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()
	Get sub form html. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. More...

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

	executeCommand ()
	Execute command. More...

	getType ()
	Get Type. More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setPostVar ($a_postvar)
	Set Post Variable. More...

	getPostVar ()
	Get Post Variable. More...

	getFieldId ()
	Get Post Variable. More...

	setInfo ($a_info)
	Set Information Text. More...

	getInfo ()
	Get Information Text. More...

	setAlert ($a_alert)
	Set Alert Text. More...

	getAlert ()
	Get Alert Text. More...

	setRequired ($a_required)
	Set Required. More...

	getRequired ()
	Get Required. More...

	setDisabled ($a_disabled)
	Set Disabled. More...

	getDisabled ()
	Get Disabled. More...

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

	setParentForm ($a_parentform)
	Set Parent Form. More...

	getParentForm ()
	Get Parent Form. More...

	setParent ($a_val)
	Set Parent GUI object. More...

	getParent ()
	Get Parent GUI object. More...

	getSubForm ()
	Get sub form html. More...

	hideSubForm ()
	Sub form hidden on init? More...

	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders) More...

	getHiddenTitle ()
	Get hidden title. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. More...

	serializeData ()
	serialize data More...

	unserializeData ($a_data)
	unserialize data More...

	writeToSession ()
	Write to session. More...

	clearFromSession ()
	Clear session value. More...

	readFromSession ()
	Read from session. More...

	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties) More...

	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi. More...

	getMulti ()
	Get Multi. More...

	setMultiValues (array $a_values)
	Set multi values. More...

	getMultiValues ()
	Get multi values. More...

	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...

	stripSlashesAddSpaceFallback ($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...

Protected Attributes
	$options

	$value

	$addCommand

	$intlink

	$intlinktext

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
	$ctrl

	$lng

	$type

	$title

	$postvar

	$info

	$alert

	$required = false

	$parentgui

	$parentform

	$hidden_title = ""

	$multi = false

	$multi_sortable = false

	$multi_addremove = true

	$multi_values

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...

Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...

	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

Detailed Description

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 13 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 27 of file class.ilSuggestedSolutionSelectorGUI.php.

References ilFormPropertyGUI\setType().

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

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

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

References $_POST, $DIC, ilFormPropertyGUI\$lng, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), and ilUtil\stripSlashes().

     {
         global $DIC;
         $lng = $DIC['lng'];
         
         $_POST[$this->getPostVar()] =
             ilUtil::stripSlashes($_POST[$this->getPostVar()]);
         if ($this->getRequired() && trim($_POST[$this->getPostVar()]) == "") {
             $this->setAlert($lng->txt("msg_input_is_required"));
 
             return false;
         }
         return $this->checkSubItemsInput();
     }

Here is the call graph for this function:

◆ getAddCommand()

ilSuggestedSolutionSelectorGUI::getAddCommand ( )

Get add command.

Returns: string add command

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

Referenced by insert().

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

Here is the caller graph for this function:

◆ getInternalLink()

ilSuggestedSolutionSelectorGUI::getInternalLink ( )

Get internal linnk.

Returns: string Internal link

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

References $intlink.

Referenced by insert().

     {
         return $this->intlink;
     }

Here is the caller graph for this function:

◆ getInternalLinkText()

ilSuggestedSolutionSelectorGUI::getInternalLinkText ( )

Get internal link text.

Returns: string Internal link text

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

References $intlinktext.

Referenced by insert().

     {
         return $this->intlinktext;
     }

Here is the caller graph for this function:

◆ getOptions()

ilSuggestedSolutionSelectorGUI::getOptions ( )

Get Options.

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

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

References $options.

Referenced by insert().

     {
         return $this->options;
     }

Here is the caller graph for this function:

◆ getValue()

ilSuggestedSolutionSelectorGUI::getValue ( )

Get Value.

Returns: string Value

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

References $value.

Referenced by insert().

     {
         return $this->value;
     }

Here is the caller graph for this function:

◆ insert()

ilSuggestedSolutionSelectorGUI::insert ( & $a_tpl )

Insert property html.

Returns: int Size

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

References $DIC, ilFormPropertyGUI\$lng, $template, getAddCommand(), ilFormPropertyGUI\getDisabled(), getInternalLink(), getInternalLinkText(), getOptions(), ilFormPropertyGUI\getPostVar(), and getValue().

     {
         global $DIC;
         $lng = $DIC['lng'];
 
         $template = new ilTemplate("tpl.prop_suggestedsolutionselector.html", true, true, "Modules/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", $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()) ? $lng->txt("change") : $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();
     }

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 118 of file class.ilSuggestedSolutionSelectorGUI.php.

     {
         $this->addCommand = $a_add_command;
     }

◆ setInternalLink()

ilSuggestedSolutionSelectorGUI::setInternalLink ( $a_value )

Set internal link.

Parameters

string $a_value Value

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

     {
         $this->intlink = $a_value;
     }

◆ setInternalLinkText()

ilSuggestedSolutionSelectorGUI::setInternalLinkText ( $a_value )

Set internal link.text.

Parameters

string $a_value Internal link text

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

     {
         $this->intlinktext = $a_value;
     }

◆ setOptions()

ilSuggestedSolutionSelectorGUI::setOptions ( $a_options )

Set Options.

Parameters

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

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

     {
         $this->options = $a_options;
     }

◆ setValue()

ilSuggestedSolutionSelectorGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

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

Referenced by setValueByArray().

     {
         $this->value = $a_value;
     }

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 138 of file class.ilSuggestedSolutionSelectorGUI.php.

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

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

Here is the call graph for this function:

Field Documentation

◆ $addCommand

ilSuggestedSolutionSelectorGUI::$addCommand

protected

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

◆ $intlink

ilSuggestedSolutionSelectorGUI::$intlink

protected

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

Referenced by getInternalLink().

◆ $intlinktext

ilSuggestedSolutionSelectorGUI::$intlinktext

protected

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

Referenced by getInternalLinkText().

◆ $options

ilSuggestedSolutionSelectorGUI::$options

protected

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

Referenced by getOptions().

◆ $value

ilSuggestedSolutionSelectorGUI::$value

protected

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

Referenced by getValue().

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

Modules/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