This class represents a repository selector in a property form. More...

Inheritance diagram for ilRepositorySelectorInputGUI:

Collaboration diagram for ilRepositorySelectorInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")

	setValue ($a_value)

	getValue ()

	setValueByArray (array $a_values)

	setSelectText (string $a_val)

	getSelectText ()

	setHeaderMessage (string $a_val)

	getHeaderMessage ()

	setClickableTypes (array $a_types)

	getClickableTypes ()

	checkInput ()

	getInput ()

	showRepositorySelection ()

	selectRepositoryItem ()

	reset ()

	render ($a_mode="property_form")

	insert (ilTemplate $a_tpl)

	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. 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
	getHighlightedNode ()

	getVisibleTypes ()

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
array	$clickable_types = []

string	$hm = ""

string	$select_text = ""

ilGlobalTemplateInterface	$tpl

ilTree	$tree

ilObjUser	$user

ilObjectDataCache	$obj_data_cache

array	$options = []

int	$value = 0

array	$container_types = array("root", "cat", "grp", "fold", "crs")

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 class represents a repository selector in a property form.

The implementation is kind of beta. It looses all other inputs, if the selector link is used.

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

Deprecated:: 12 This component will be removed with ILIAS 12

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

Constructor & Destructor Documentation

◆ __construct()

ilRepositorySelectorInputGUI::__construct	(	string	$a_title = `""`,
		string	$a_postvar = `""`
	)

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

References $DIC, ilFormPropertyGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), setClickableTypes(), setHeaderMessage(), setSelectText(), ilFormPropertyGUI\setType(), ilLanguage\txt(), and ILIAS\Repository\user().

       {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->tpl = $DIC["tpl"];
         $this->ctrl = $DIC->ctrl();
         $this->tree = $DIC->repositoryTree();
         $this->user = $DIC->user();
         $this->obj_data_cache = $DIC["ilObjDataCache"];
         $lng = $DIC->language();
 
         parent::__construct($a_title, $a_postvar);
         $this->setClickableTypes($this->container_types);
         $this->setHeaderMessage($lng->txt('search_area_info'));
         $this->setType("rep_select");
         $this->setSelectText($lng->txt("select"));
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilRepositorySelectorInputGUI::checkInput ( )

Definition at line 114 of file class.ilRepositorySelectorInputGUI.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:

◆ getClickableTypes()

ilRepositorySelectorInputGUI::getClickableTypes ( )

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

References $clickable_types.

Referenced by getVisibleTypes(), render(), and showRepositorySelection().

                                        : array
     {
         return $this->clickable_types;
     }

Here is the caller graph for this function:

◆ getHeaderMessage()

ilRepositorySelectorInputGUI::getHeaderMessage ( )

Definition at line 99 of file class.ilRepositorySelectorInputGUI.php.

References $hm.

Referenced by showRepositorySelection().

                                       : string
     {
         return $this->hm;
     }

Here is the caller graph for this function:

◆ getHighlightedNode()

ilRepositorySelectorInputGUI::getHighlightedNode ( )

protected

Definition at line 257 of file class.ilRepositorySelectorInputGUI.php.

References $tree, ilObject\_lookupType(), ilTree\getParentId(), getValue(), and getVisibleTypes().

Referenced by showRepositorySelection().

                                            : int
     {
         $tree = $this->tree;
 
         if (!in_array(ilObject::_lookupType($this->getValue(), true), $this->getVisibleTypes())) {
             return $tree->getParentId($this->getValue());
         }
 
         return $this->getValue();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInput()

ilRepositorySelectorInputGUI::getInput ( )

Definition at line 125 of file class.ilRepositorySelectorInputGUI.php.

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

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

Here is the call graph for this function:

◆ getSelectText()

ilRepositorySelectorInputGUI::getSelectText ( )

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

References $select_text.

Referenced by render().

                                    : string
     {
         return $this->select_text;
     }

Here is the caller graph for this function:

◆ getTableFilterHTML()

ilRepositorySelectorInputGUI::getTableFilterHTML ( )

Get input item HTML to be inserted into table filters.

Implements ilTableFilterItem.

Definition at line 251 of file class.ilRepositorySelectorInputGUI.php.

References render().

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

Here is the call graph for this function:

◆ getValue()

ilRepositorySelectorInputGUI::getValue ( )

Definition at line 74 of file class.ilRepositorySelectorInputGUI.php.

References $value.

Referenced by getHighlightedNode(), render(), and showRepositorySelection().

                               : int
     {
         return $this->value;
     }

Here is the caller graph for this function:

◆ getVisibleTypes()

ilRepositorySelectorInputGUI::getVisibleTypes ( )

protected

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

References getClickableTypes().

Referenced by getHighlightedNode(), and showRepositorySelection().

                                         : array
     {
         return array_merge($this->container_types, $this->getClickableTypes());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insert()

ilRepositorySelectorInputGUI::insert ( ilTemplate $a_tpl )

Definition at line 244 of file class.ilRepositorySelectorInputGUI.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()

ilRepositorySelectorInputGUI::render ( $a_mode = "property_form" )

Definition at line 181 of file class.ilRepositorySelectorInputGUI.php.

References ilFormPropertyGUI\$ctrl, ilFormPropertyGUI\$lng, $nd, $obj_data_cache, ilFormPropertyGUI\$parent_gui, ilFormPropertyGUI\$title, $tree, ILIAS\UICore\GlobalTemplate\get(), getClickableTypes(), ilFormPropertyGUI\getFieldId(), ilTree\getNodeData(), ilFormPropertyGUI\getParentTable(), ilFormPropertyGUI\getPostVar(), getSelectText(), getValue(), ilLegacyFormElementsUtil\prepareFormOutput(), ROOT_FOLDER_ID, ILIAS\UICore\GlobalTemplate\setVariable(), and ilLanguage\txt().

Referenced by getTableFilterHTML(), and insert().

                                                      : string
     {
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
         $ilObjDataCache = $this->obj_data_cache;
         $tree = $this->tree;
         $parent_gui = "";
 
         $tpl = new ilTemplate("tpl.prop_rep_select.html", true, true, "components/ILIAS/Form");
 
         $tpl->setVariable("POST_VAR", $this->getPostVar());
         $tpl->setVariable("ID", $this->getFieldId());
         $tpl->setVariable("PROPERTY_VALUE", ilLegacyFormElementsUtil::prepareFormOutput((string) $this->getValue()));
         $tpl->setVariable("TXT_SELECT", $this->getSelectText());
         $tpl->setVariable("TXT_RESET", $lng->txt("reset"));
         switch ($a_mode) {
             case "property_form":
                 $parent_gui = "ilpropertyformgui";
                 break;
 
             case "table_filter":
                 $parent_gui = get_class($this->getParentTable());
                 break;
         }
 
         $ilCtrl->setParameterByClass(
             "ilrepositoryselectorinputgui",
             "postvar",
             $this->getPostVar()
         );
         $tpl->setVariable(
             "HREF_SELECT",
             $ilCtrl->getLinkTargetByClass(
                 array($parent_gui, "ilformpropertydispatchgui", "ilrepositoryselectorinputgui"),
                 "showRepositorySelection"
             )
         );
         $tpl->setVariable(
             "HREF_RESET",
             $ilCtrl->getLinkTargetByClass(
                 array($parent_gui, "ilformpropertydispatchgui", "ilrepositoryselectorinputgui"),
                 "reset"
             )
         );
 
         if ($this->getValue() > 0 && $this->getValue() != ROOT_FOLDER_ID) {
             $tpl->setVariable(
                 "TXT_ITEM",
                 $ilObjDataCache->lookupTitle($ilObjDataCache->lookupObjId($this->getValue()))
             );
         } else {
             $nd = $tree->getNodeData(ROOT_FOLDER_ID);
             $title = $nd["title"];
             if ($title == "ILIAS") {
                 $title = $lng->txt("repository");
             }
             if (in_array($nd["type"], $this->getClickableTypes())) {
                 $tpl->setVariable("TXT_ITEM", $title);
             }
         }
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset()

ilRepositorySelectorInputGUI::reset ( )

Definition at line 171 of file class.ilRepositorySelectorInputGUI.php.

References ilFormPropertyGUI\$ctrl, setValue(), and ilFormPropertyGUI\writeToSession().

                            : void
     {
         $ilCtrl = $this->ctrl;
 
         $this->setValue("");
         $this->writeToSession();
 
         $ilCtrl->returnToParent($this);
     }

Here is the call graph for this function:

◆ selectRepositoryItem()

ilRepositorySelectorInputGUI::selectRepositoryItem ( )

Definition at line 161 of file class.ilRepositorySelectorInputGUI.php.

References ilFormPropertyGUI\$ctrl, setValue(), and ilFormPropertyGUI\writeToSession().

                                           : void
     {
         $ilCtrl = $this->ctrl;
 
         $this->setValue((string) $this->int("root_id"));
         $this->writeToSession();
 
         $ilCtrl->returnToParent($this);
     }

Here is the call graph for this function:

◆ setClickableTypes()

ilRepositorySelectorInputGUI::setClickableTypes ( array $a_types )

Definition at line 104 of file class.ilRepositorySelectorInputGUI.php.

Referenced by __construct().

                                                      : void
     {
         $this->clickable_types = $a_types;
     }

Here is the caller graph for this function:

◆ setHeaderMessage()

ilRepositorySelectorInputGUI::setHeaderMessage ( string $a_val )

Definition at line 94 of file class.ilRepositorySelectorInputGUI.php.

Referenced by __construct().

                                                    : void
     {
         $this->hm = $a_val;
     }

Here is the caller graph for this function:

◆ setSelectText()

ilRepositorySelectorInputGUI::setSelectText ( string $a_val )

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

Referenced by __construct(), ilLPTableBaseGUI\initBaseFilter(), ilMStListCoursesTableGUI\initFilter(), ilMStShowUserCoursesTableGUI\initFilter(), and ilUserTableGUI\initFilter().

                                                 : void
     {
         $this->select_text = $a_val;
     }

Here is the caller graph for this function:

◆ setValue()

ilRepositorySelectorInputGUI::setValue ( $a_value )

Parameters

int | string $a_value

Returns: void

Definition at line 69 of file class.ilRepositorySelectorInputGUI.php.

References ilFormPropertyGUI\int().

Referenced by reset(), selectRepositoryItem(), and setValueByArray().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValueByArray()

ilRepositorySelectorInputGUI::setValueByArray ( array $a_values )

Definition at line 79 of file class.ilRepositorySelectorInputGUI.php.

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

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

Here is the call graph for this function:

◆ showRepositorySelection()

ilRepositorySelectorInputGUI::showRepositorySelection ( )

Definition at line 130 of file class.ilRepositorySelectorInputGUI.php.

References ilFormPropertyGUI\$ctrl, $tpl, getClickableTypes(), getHeaderMessage(), getHighlightedNode(), ilFormPropertyGUI\getPostVar(), getValue(), getVisibleTypes(), ILIAS\UICore\GlobalTemplate\setContent(), and ilCtrl\setParameter().

                                              : void
     {
         $tpl = $this->tpl;
         $ilCtrl = $this->ctrl;
 
         $ilCtrl->setParameter($this, "postvar", $this->getPostVar());
 
         $this->tpl->setOnScreenMessage('info', $this->getHeaderMessage());
 
         $exp = new ilRepositorySelectorExplorerGUI(
             $this,
             "showRepositorySelection",
             $this,
             "selectRepositoryItem",
             "root_id"
         );
         $exp->setTypeWhiteList($this->getVisibleTypes());
         $exp->setClickableTypes($this->getClickableTypes());
 
         if ($this->getValue()) {
             $exp->setPathOpen($this->getValue());
             $exp->setHighlightedNode((string) $this->getHighlightedNode());
         }
 
         if ($exp->handleCommand()) {
             return;
         }
         // build html-output
         $tpl->setContent($exp->getHTML());
     }