ilAdvSelectInputGUI Class Reference

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

Inheritance diagram for ilAdvSelectInputGUI:

Collaboration diagram for ilAdvSelectInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")
	addOption (string $a_value, string $a_text, string $a_html="")
	getOptions ()
	setValue (string $a_value)
	getValue ()
	setValueByArray (array $a_values)
	checkInput ()
	getInput ()
	insert (ilTemplate $a_tpl)
	getOnloadCode ()
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 Member Functions
	getAdvSelection ()
Protected Member Functions inherited from ilFormPropertyGUI
	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
array	$options = array()
string	$value = ""
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...

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 an advanced selection list property in a property form. It can hold graphical selection items, uses javascript and falls back to a normal selection list, when javascript is disabled.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilAdvSelectInputGUI::__construct	(	string	$a_title = "",
		string	$a_postvar = ""
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setType().

      {
        global $DIC;

        $this->lng = $DIC->language();
        parent::__construct($a_title, $a_postvar);
        $this->setType("advselect");
    }

Here is the call graph for this function:

Member Function Documentation

addOption()

ilAdvSelectInputGUI::addOption	(	string	$a_value,
		string	$a_text,
		string	$a_html = ""
	)

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

     : void {
        $this->options[$a_value] = array("value" => $a_value,
            "txt" => $a_text, "html" => $a_html);
    }

checkInput()

ilAdvSelectInputGUI::checkInput

(

)

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

References ilFormPropertyGUI\$lng, ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), ilFormPropertyGUI\str(), and ilLanguage\txt().

                                : bool
    {
        $lng = $this->lng;

        if ($this->getRequired() && trim($this->str($this->getPostVar())) == "") {
            $this->setAlert($lng->txt("msg_input_is_required"));
            return false;
        }
        return true;
    }

Here is the call graph for this function:

getAdvSelection()

ilAdvSelectInputGUI::getAdvSelection ( )

protected

Definition at line 89 of file class.ilAdvSelectInputGUI.php.

References ilAdvancedSelectionListGUI\DOWN_ARROW_DARK, getOptions(), ilFormPropertyGUI\getPostVar(), getValue(), and ilAdvancedSelectionListGUI\ON_ITEM_CLICK_FORM_SELECT.

Referenced by getOnloadCode(), and insert().

                                        : ilAdvancedSelectionListGUI
    {
        $selection = new ilAdvancedSelectionListGUI();
        $selection->setFormSelectMode(
            $this->getPostVar(),
            "",
            false,
            "",
            "",
            "",
            ""
        );
        $selection->setId($this->getPostVar());
        $selection->setHeaderIcon(ilAdvancedSelectionListGUI::DOWN_ARROW_DARK);
        $selection->setSelectedValue($this->getValue());
        $selection->setUseImages(false);
        $selection->setOnClickMode(ilAdvancedSelectionListGUI::ON_ITEM_CLICK_FORM_SELECT);

        foreach ($this->getOptions() as $option) {
            $selection->addItem(
                $option["txt"],
                $option["value"],
                "",
                "",
                $option["value"],
                "",
                $option["html"]
            );
            if ($this->getValue() == $option["value"]) {
                $selection->setListTitle($option["txt"]);
            }
        }
        return $selection;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInput()

ilAdvSelectInputGUI::getInput

(

)

Definition at line 84 of file class.ilAdvSelectInputGUI.php.

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

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

Here is the call graph for this function:

getOnloadCode()

ilAdvSelectInputGUI::getOnloadCode

(

)

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

References getAdvSelection().

                                   : array
    {
        return $this->getAdvSelection()->getOnloadCode();
    }

Here is the call graph for this function:

getOptions()

ilAdvSelectInputGUI::getOptions

(

)

Definition at line 53 of file class.ilAdvSelectInputGUI.php.

References $options.

Referenced by getAdvSelection().

                                : array
    {
        return $this->options;
    }

Here is the caller graph for this function:

getValue()

ilAdvSelectInputGUI::getValue

(

)

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

References $value.

Referenced by getAdvSelection().

                              : string
    {
        return $this->value;
    }

Here is the caller graph for this function:

insert()

ilAdvSelectInputGUI::insert

(

ilTemplate

$a_tpl

)

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

References getAdvSelection(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

                                             : void
    {
        $selection = $this->getAdvSelection();
        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $selection->getHTML());
        $a_tpl->parseCurrentBlock();
    }

Here is the call graph for this function:

setValue()

ilAdvSelectInputGUI::setValue

(

string

$a_value

)

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

Referenced by setValueByArray().

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

Here is the caller graph for this function:

setValueByArray()

ilAdvSelectInputGUI::setValueByArray

(

array

$a_values

)

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

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

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

Here is the call graph for this function:

Field Documentation

$options

array ilAdvSelectInputGUI::$options = array()

protected

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

Referenced by getOptions().

$value

string ilAdvSelectInputGUI::$value = ""

protected

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

Referenced by getValue().

---

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

• Services/Form/classes/class.ilAdvSelectInputGUI.php