ilRepositorySelector2InputGUI 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 ilRepositorySelector2InputGUI:

Collaboration diagram for ilRepositorySelector2InputGUI:

Public Member Functions
	__construct (string $a_title, string $a_postvar, bool $a_multi=false, ?object $forwarder=null)
	setTitleModifier (?Closure $a_val)
	getTitleModifier ()
	getTitleForNodeId ($a_id)
	getExplorerGUI ()
	setExplorerGUI (\ilRepositorySelectorExplorerGUI $explorer)
	getOnloadCode ()
	getHTML ()
	render (string $a_mode="property_form")
Public Member Functions inherited from ilExplorerSelectInputGUI
	__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 Attributes
Closure	$title_modifier = null
Protected Attributes inherited from ilExplorerSelectInputGUI
	$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 repository nodes

Author

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

Definition at line 27 of file class.ilRepositorySelector2InputGUI.php.

Constructor & Destructor Documentation

__construct()

ilRepositorySelector2InputGUI::__construct	(	string	$a_title,
		string	$a_postvar,
		bool	$a_multi = false,
		?object	$forwarder = null
	)

Parameters

object | null

$forwarder

object that forwards to ilFormPropertyDispatchGUI, usually a form object but might be a table as well, e.g. if inputs are used in filter

Definition at line 35 of file class.ilRepositorySelector2InputGUI.php.

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

      {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->multi_nodes = $a_multi;
        $this->postvar = $a_postvar;
        $forwarder_class = (is_null($forwarder))
            ? ilPropertyFormGUI::class
            : get_class($forwarder);
        $this->explorer_gui = new ilRepositorySelectorExplorerGUI(
            [$forwarder_class, ilFormPropertyDispatchGUI::class, ilRepositorySelector2InputGUI::class],
            $this->getExplHandleCmd(),
            $this,
            "selectRepositoryItem",
            "root_id",
            "rep_exp_sel_" . $a_postvar
        );
        $this->explorer_gui->setSelectMode($a_postvar . "_sel", $this->multi_nodes);

        parent::__construct($a_title, $a_postvar, $this->explorer_gui, $this->multi_nodes);
        $this->setType("rep_select");
    }

Here is the call graph for this function:

Member Function Documentation

getExplorerGUI()

ilRepositorySelector2InputGUI::getExplorerGUI

(

)

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

References ilExplorerSelectInputGUI\$explorer_gui.

Referenced by ilCronOerHarvester\addCustomSettingsToForm(), ilObjStudyProgrammeAutoCategoriesGUI\getForm(), ilCourseLPBadgeGUI\initConfigForm(), ilMediaCreationGUI\initPoolSelection(), and ilBookingGatewayGUI\initSettingsForm().

                                    : ilRepositorySelectorExplorerGUI
    {
        return $this->explorer_gui;
    }

Here is the caller graph for this function:

getHTML()

ilRepositorySelector2InputGUI::getHTML

(

)

Definition at line 106 of file class.ilRepositorySelector2InputGUI.php.

References ilFormPropertyGUI\$ctrl, ilCtrl\setParameterByClass(), and ilFormPropertyGUI\str().

                             : string
    {
        $ilCtrl = $this->ctrl;
        $ilCtrl->setParameterByClass("ilformpropertydispatchgui", "postvar", $this->postvar);
        $html = parent::render();
        $ilCtrl->setParameterByClass("ilformpropertydispatchgui", "postvar", $this->str("postvar"));
        return $html;
    }

Here is the call graph for this function:

getOnloadCode()

ilRepositorySelector2InputGUI::getOnloadCode

(

)

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

References ilFormPropertyGUI\getFieldId().

                                   : array
    {
        return [
            "il.Explorer2.initSelect('" . $this->getFieldId() . "');"
        ];
    }

Here is the call graph for this function:

getTitleForNodeId()

ilRepositorySelector2InputGUI::getTitleForNodeId

(

$a_id

)

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

References $c, ilObject\_lookupObjId(), ilObject\_lookupTitle(), and getTitleModifier().

                                            : string
    {
        $c = $this->getTitleModifier();
        if (is_callable($c)) {
            return $c($a_id);
        }
        return ilObject::_lookupTitle(ilObject::_lookupObjId((int) $a_id));
    }

Here is the call graph for this function:

getTitleModifier()

ilRepositorySelector2InputGUI::getTitleModifier

(

)

Definition at line 75 of file class.ilRepositorySelector2InputGUI.php.

References $title_modifier.

Referenced by getTitleForNodeId().

                                      : ?Closure
    {
        return $this->title_modifier;
    }

Here is the caller graph for this function:

render()

ilRepositorySelector2InputGUI::render

(

string

$a_mode = "property_form"

)

Definition at line 115 of file class.ilRepositorySelector2InputGUI.php.

References ilFormPropertyGUI\$ctrl, ilCtrl\setParameterByClass(), and ilFormPropertyGUI\str().

                                                            : string
    {
        $ilCtrl = $this->ctrl;
        $ilCtrl->setParameterByClass("ilformpropertydispatchgui", "postvar", $this->postvar);
        $ret = parent::render($a_mode);
        $ilCtrl->setParameterByClass("ilformpropertydispatchgui", "postvar", $this->str("postvar"));
        return $ret;
    }

Here is the call graph for this function:

setExplorerGUI()

ilRepositorySelector2InputGUI::setExplorerGUI

(

\ilRepositorySelectorExplorerGUI

$explorer

)

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

                                                                              : void
    {
        $this->explorer_gui = $explorer;
    }

setTitleModifier()

ilRepositorySelector2InputGUI::setTitleModifier

(

?Closure

$a_val

)

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

Referenced by ilCourseLPBadgeGUI\initConfigForm().

                                                     : void
    {
        $this->title_modifier = $a_val;
        if ($a_val != null) {
            $this->explorer_gui->setNodeContentModifier(function ($a_node) use ($a_val) {
                return $a_val($a_node["child"]);
            });
        } else {
            $this->explorer_gui->setNodeContentModifier(null);
        }
    }

Here is the caller graph for this function:

Field Documentation

$title_modifier

Closure ilRepositorySelector2InputGUI::$title_modifier = null

protected

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

Referenced by getTitleModifier().

---

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

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