Select explorer tree nodes input GUI. More...

Inheritance diagram for ilExplorerSelectInputGUI:

Collaboration diagram for ilExplorerSelectInputGUI:

Public Member Functions
	__construct (string $a_title, string $a_postvar, ilExplorerBaseGUI $a_explorer_gui, bool $a_multi=false)

	getExplHandleCmd ()
	Get explorer handle command function. More...

	handleExplorerCommand ()
	Handle explorer command. More...

	getTitleForNodeId ($a_id)
	Get title for node id (needs to be overwritten, if explorer is not a tree eplorer. More...

	setValue ($a_value)

	getValue ()

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

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

	getInput ()

	render (string $a_mode="property_form")
	Render item. More...

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

	getTableFilterHTML ()
	Get HTML for table filter. 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
	getTableFilterLabelFor ()
	Get label "for" attribute value. More...

Protected Member Functions
	getInitializationOnLoadCode ()

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)

Protected Attributes
ilGlobalTemplateInterface	$global_template

UIServices	$ui

	$value

bool	$multi_nodes

ilExplorerBaseGUI	$explorer_gui

bool	$disabled = false

	$on_load_code
	The on load code sould only be added once, otherwise the select link opens two modals and stuff breaks (https://mantis.ilias.de/view.php?id=42821). More...

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

Select explorer tree nodes input GUI.

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

Deprecated:: 10

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

Constructor & Destructor Documentation

◆ __construct()

ilExplorerSelectInputGUI::__construct	(	string	$a_title,
		string	$a_postvar,
		ilExplorerBaseGUI	$a_explorer_gui,
		bool	$a_multi = `false`
	)

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

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

       {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->multi_nodes = $a_multi;
         $this->explorer_gui = $a_explorer_gui;
         $this->global_template = $DIC->ui()->mainTemplate();
 
         $this->ui = $DIC->ui();
 
         parent::__construct($a_title, $a_postvar);
         $this->setType("exp_select");
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilExplorerSelectInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: bool Input ok, true/false

Definition at line 136 of file class.ilExplorerSelectInputGUI.php.

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

                                 : bool
     {
         $lng = $this->lng;
 
         // check required
         if ($this->getRequired()) {
             if ((!$this->multi_nodes && trim($this->getInput()) === "") ||
                 ($this->multi_nodes && count($this->getInput()) === 0)) {
                 $this->setAlert($lng->txt("msg_input_is_required"));
                 return false;
             }
         }
         return true;
     }

Here is the call graph for this function:

◆ getExplHandleCmd()

ilExplorerSelectInputGUI::getExplHandleCmd ( )

Get explorer handle command function.

Definition at line 72 of file class.ilExplorerSelectInputGUI.php.

Referenced by ilTaxSelectInputGUI\__construct(), and ilRepositorySelector2InputGUI\__construct().

                                       : string
     {
         return "handleExplorerCommand";
     }

Here is the caller graph for this function:

◆ getInitializationOnLoadCode()

ilExplorerSelectInputGUI::getInitializationOnLoadCode ( )

protected

Definition at line 268 of file class.ilExplorerSelectInputGUI.php.

References $on_load_code, ilFormPropertyGUI\getFieldId(), and ILIAS\Repository\ui().

Referenced by ilRepositorySelector2InputGUI\getOnloadCode(), and render().

                                                     : string
     {
         if (isset($this->on_load_code)) {
             return $this->on_load_code;
         }
 
         $modal = $this->ui->factory()->modal()->roundtrip(
             'placeholder',
             $this->ui->factory()->legacy('<div id="' . $this->getFieldId() . '_expl_marker"></div>')
         );
         $rendered_modal = str_replace(
             ["\r\n", "\n", "\r"],
             ' ',
             addslashes(json_encode($this->ui->renderer()->renderAsync($modal)))
         );
         return $this->on_load_code = 'il.Explorer2.initSelect(\'' . $this->getFieldId() . '\',"' .
             $rendered_modal . '",\'' .
             $modal->getShowSignal() . '\',\'' .
             $modal->getCloseSignal() . '\');';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInput()

ilExplorerSelectInputGUI::getInput ( )

Returns: string|string[]

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

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

Referenced by checkInput().

     {
         if ($this->multi_nodes) {
             return $this->strArray($this->getPostVar());
         } else {
             return $this->str($this->getPostVar());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTableFilterHTML()

ilExplorerSelectInputGUI::getTableFilterHTML ( )

Get HTML for table filter.

Implements ilTableFilterItem.

Definition at line 262 of file class.ilExplorerSelectInputGUI.php.

References render().

                                         : string
     {
         $html = $this->render("table_filter");
         return $html;
     }

Here is the call graph for this function:

◆ getTitleForNodeId()

ilExplorerSelectInputGUI::getTitleForNodeId ( $a_id )

abstract

Get title for node id (needs to be overwritten, if explorer is not a tree eplorer.

Referenced by handleExplorerCommand(), and render().

Here is the caller graph for this function:

◆ getValue()

ilExplorerSelectInputGUI::getValue ( )

Returns: string|int|array node id or array of node ids (multi mode)

Definition at line 119 of file class.ilExplorerSelectInputGUI.php.

References $value.

Referenced by handleExplorerCommand(), and render().

     {
         return $this->value;
     }

Here is the caller graph for this function:

◆ handleExplorerCommand()

ilExplorerSelectInputGUI::handleExplorerCommand ( )

Handle explorer command.

Definition at line 80 of file class.ilExplorerSelectInputGUI.php.

References getTitleForNodeId(), and getValue().

                                            : void
     {
         $val = $this->getValue();
         if (is_array($val)) {
             foreach ($val as $v) {
                 $this->explorer_gui->setNodeOpen($v);
                 $this->explorer_gui->setNodeSelected($v);
             }
         } elseif ($val != "") {
             $this->explorer_gui->setNodeOpen($val);
             $this->explorer_gui->setNodeSelected($val);
         }
         $this->explorer_gui->handleCommand();
     }

Here is the call graph for this function:

◆ insert()

ilExplorerSelectInputGUI::insert ( ilTemplate $a_tpl )

Insert property html.

Definition at line 252 of file class.ilExplorerSelectInputGUI.php.

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

                                              : void
     {
         $a_tpl->setCurrentBlock("prop_generic");
         $a_tpl->setVariable("PROP_GENERIC", $this->render());
         $a_tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

◆ render()

ilExplorerSelectInputGUI::render ( string $a_mode = "property_form" )

Render item.

Definition at line 166 of file class.ilExplorerSelectInputGUI.php.

References ilFormPropertyGUI\$lng, $on_load_code, ILIAS\UI\examples\Input\Field\Checkbox\disabled(), ilFormPropertyGUI\getFieldId(), getInitializationOnLoadCode(), ilLinkButton\getInstance(), ilFormPropertyGUI\getPostVar(), getTitleForNodeId(), getValue(), and ilLanguage\txt().

Referenced by getTableFilterHTML(), and insert().

                                                             : string
     {
         $lng = $this->lng;
 
         $on_load_code = $this->getInitializationOnLoadCode();
 
         $this->global_tpl->addJavascript("assets/js/Explorer2.js");
         $this->global_tpl->addJavascript("asserts/js/LegacyModal.js");
         $this->global_tpl->addOnLoadCode($on_load_code);
 
         $tpl = new ilTemplate("tpl.prop_expl_select.html", true, true, "components/ILIAS/UIComponent/Explorer2");
 
         if ($a_mode !== "property_form") {
             $tpl->touchBlock("tiny_presentation");
         }
 
         // set values
         $val = $this->getValue();
         if (is_array($val)) {
             $val_txt = $sep = "";
             foreach ($val as $v) {
                 $tpl->setCurrentBlock("node_hid");
                 $tpl->setVariable("HID_NAME", $this->getPostVar() . "[]");
                 $tpl->setVariable("HID_VAL", $v);
                 $tpl->parseCurrentBlock();
                 $val_txt .= $sep . $this->getTitleForNodeId($v);
                 $sep = ", ";
                 $this->explorer_gui->setNodeOpen($v);
                 $this->explorer_gui->setNodeSelected($v);
             }
             $tpl->setVariable("VAL_TXT", $val_txt);
         } elseif ($val != "") {
             $tpl->setCurrentBlock("node_hid");
             $tpl->setVariable("HID_NAME", $this->getPostVar());
             $tpl->setVariable("HID_VAL", $val);
             $tpl->parseCurrentBlock();
             $tpl->setVariable("VAL_TXT", $this->getTitleForNodeId($val));
             $this->explorer_gui->setNodeOpen($val);
             $this->explorer_gui->setNodeSelected($val);
         }
 
         $tpl->setVariable("POST_VAR", $this->getPostVar());
         $tpl->setVariable("ID", $this->getFieldId());
         $this->global_template->addOnLoadCode($on_load_code);
 
         //              $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($this->getValue()));
 
         //added disabled
         if (!$this->disabled) {
             $tpl->setCurrentBlock("txt_select");
             $tpl->setVariable("TXT_SELECT", $lng->txt("select"));
             $tpl->setVariable("ID_TXT_SELECT", $this->getFieldId());
             $tpl->parseCurrentBlock();
 
             $tpl->setCurrentBlock("txt_reset");
             $tpl->setVariable("TXT_RESET", $lng->txt("reset"));
             $tpl->setVariable("ID_TXT_RESET", $this->getFieldId());
             $tpl->parseCurrentBlock();
         }
 
         $tpl->setVariable("EXPL", $this->explorer_gui->getHTML());
 
         $top_tb = new ilToolbarGUI();
 
         $button = ilLinkButton::getInstance();
         $button->setCaption("select");
         $button->addCSSClass("ilExplSelectInputButS");
         $button->setOmitPreventDoubleSubmission(true);
         $top_tb->addStickyItem($button);
 
         $button = ilLinkButton::getInstance();
         $button->setCaption("cancel");
         $button->addCSSClass("ilExplSelectInputButC");
         $button->setOmitPreventDoubleSubmission(true);
         $top_tb->addStickyItem($button);
 
         // :TODO: we should probably clone the buttons properly
         $tpl->setVariable("TOP_TB", $top_tb->getHTML());
         $tpl->setVariable("BOT_TB", $top_tb->getHTML());
 
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValue()

ilExplorerSelectInputGUI::setValue ( $a_value )

Parameters

string|int|array node id or array of node ids (multi mode)

Definition at line 103 of file class.ilExplorerSelectInputGUI.php.

Referenced by ilCronOerHarvester\addCustomSettingsToForm(), and setValueByArray().

                                       : void
     {
         if ($this->multi_nodes && !is_array($a_value)) {
             if ($a_value !== false) {
                 $this->value = array($a_value);
             } else {
                 $this->value = array();
             }
         } else {
             $this->value = $a_value;
         }
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilExplorerSelectInputGUI::setValueByArray ( array $a_values )

Set value by array.

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

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

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

Here is the call graph for this function:

Field Documentation

◆ $disabled

bool ilExplorerSelectInputGUI::$disabled = false

protected

Definition at line 39 of file class.ilExplorerSelectInputGUI.php.

◆ $explorer_gui

ilExplorerBaseGUI ilExplorerSelectInputGUI::$explorer_gui

protected

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

Referenced by ilRepositorySelector2InputGUI\getExplorerGUI().

◆ $global_template

ilGlobalTemplateInterface ilExplorerSelectInputGUI::$global_template

protected

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

◆ $multi_nodes

bool ilExplorerSelectInputGUI::$multi_nodes

protected

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

◆ $on_load_code

ilExplorerSelectInputGUI::$on_load_code

protected

The on load code sould only be added once, otherwise the select link opens two modals and stuff breaks (https://mantis.ilias.de/view.php?id=42821).

This is only necessary if the input is rendered twice, and might lead to problems if the post var is changed in between.

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

Referenced by getInitializationOnLoadCode(), and render().

◆ $ui

UIServices ilExplorerSelectInputGUI::$ui

protected

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

◆ $value

ilExplorerSelectInputGUI::$value

protected

Definition at line 36 of file class.ilExplorerSelectInputGUI.php.

Referenced by getValue().

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

components/ILIAS/UIComponent/Explorer2/classes/class.ilExplorerSelectInputGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getExplHandleCmd()

◆ getInitializationOnLoadCode()

◆ getInput()

◆ getTableFilterHTML()

◆ getTitleForNodeId()

◆ getValue()

◆ handleExplorerCommand()

◆ insert()

◆ render()

◆ setValue()

◆ setValueByArray()

Field Documentation

◆ $disabled

◆ $explorer_gui

◆ $global_template

◆ $multi_nodes

◆ $on_load_code

◆ $ui

◆ $value