ilExplorerSelectInputGUI 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 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
	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...
	getTableFilterLabelFor ()
	Get label "for" attribute value. More...

Protected Attributes
	$value
bool	$multi_nodes
ilExplorerBaseGUI	$explorer_gui
bool	$disabled = false
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
	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 Select explorer tree nodes input GUI

Author

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

Definition at line 24 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 34 of file class.ilExplorerSelectInputGUI.php.

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

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

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

Reimplemented from ilFormPropertyGUI.

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

                                : 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;
    }

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

Here is the call graph for this function:

getExplHandleCmd()

ilExplorerSelectInputGUI::getExplHandleCmd

(

)

Get explorer handle command function.

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

                                      : string
    {
        return "handleExplorerCommand";
    }

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

Here is the caller graph for this function:

getInput()

ilExplorerSelectInputGUI::getInput

(

)

Returns

string|string[]

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

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

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

Referenced by checkInput().

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 245 of file class.ilExplorerSelectInputGUI.php.

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

References render().

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.

Reimplemented in ilRepositorySelector2InputGUI, and ilTaxSelectInputGUI.

Referenced by 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 101 of file class.ilExplorerSelectInputGUI.php.

    {
        return $this->value;
    }

References $value.

Referenced by handleExplorerCommand(), and render().

Here is the caller graph for this function:

handleExplorerCommand()

ilExplorerSelectInputGUI::handleExplorerCommand

(

)

Handle explorer command.

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

                                           : 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();
    }

References getValue().

Here is the call graph for this function:

insert()

ilExplorerSelectInputGUI::insert

(

ilTemplate

$a_tpl

)

Insert property html.

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

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

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

Here is the call graph for this function:

render()

ilExplorerSelectInputGUI::render

(

string

$a_mode = "property_form"

)

Render item.

Reimplemented in ilRepositorySelector2InputGUI.

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

                                                            : string
    {
        $lng = $this->lng;
 
        $this->global_tpl->addJavascript("./Services/UIComponent/Explorer2/js/Explorer2.js");
        $this->global_tpl->addJavascript("./Services/UIComponent/Modal/js/Modal.js");
        $this->global_tpl->addOnLoadCode(
            "il.Explorer2.initSelect('" . $this->getFieldId() . "');"
        );
 
        $tpl = new ilTemplate("tpl.prop_expl_select.html", true, true, "Services/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());
        $ol_js = "il.Explorer2.initSelect('" . $this->getFieldId() . "');";
        $this->global_template->addOnLoadCode($ol_js);
 
        //              $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();
    }

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

Referenced by getTableFilterHTML(), and insert().

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 85 of file class.ilExplorerSelectInputGUI.php.

                                      : 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;
        }
    }

Referenced by setValueByArray().

Here is the caller graph for this function:

setValueByArray()

ilExplorerSelectInputGUI::setValueByArray

(

array

$a_values

)

Set value by array.

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

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

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

Here is the call graph for this function:

Field Documentation

$disabled

bool ilExplorerSelectInputGUI::$disabled = false

protected

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

$explorer_gui

ilExplorerBaseGUI ilExplorerSelectInputGUI::$explorer_gui

protected

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

Referenced by ilRepositorySelector2InputGUI\getExplorerGUI().

$multi_nodes

bool ilExplorerSelectInputGUI::$multi_nodes

protected

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

$value

ilExplorerSelectInputGUI::$value

protected

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

Referenced by getValue().

---

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

• Services/UIComponent/Explorer2/classes/class.ilExplorerSelectInputGUI.php