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

Collaboration diagram for ilTaxSelectInputGUI:

Public Member Functions
	__construct (int $a_taxonomy_id, string $a_postvar, bool $a_multi=false)
	setTaxonomyId (int $a_val)
	getTaxonomyId ()
	getTitleForNodeId ($a_id)
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
bool	$multi_nodes
ilObjTaxonomy	$tax
int	$taxononmy_id
Protected Attributes inherited from ilExplorerSelectInputGUI
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...
Protected Member Functions inherited from ilExplorerSelectInputGUI
	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)

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 taxonomy nodes input GUI

Author

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

Definition at line 24 of file class.ilTaxSelectInputGUI.php.

Constructor & Destructor Documentation

__construct()

ilTaxSelectInputGUI::__construct	(	int	$a_taxonomy_id,
		string	$a_postvar,
		bool	$a_multi = false
	)

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

References $DIC, ilFormPropertyGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), ilObject\_lookupTitle(), ILIAS\Repository\ctrl(), ilExplorerSelectInputGUI\getExplHandleCmd(), getTaxonomyId(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), setTaxonomyId(), and ilFormPropertyGUI\setType().

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();

        $lng->loadLanguageModule("tax");
        $this->multi_nodes = $a_multi;
        $ilCtrl->setParameterByClass("ilformpropertydispatchgui", "postvar", $a_postvar);
        $this->explorer_gui = new ilTaxonomyExplorerGUI(
            array("ilformpropertydispatchgui", "iltaxselectinputgui"),
            $this->getExplHandleCmd(),
            $a_taxonomy_id,
            "",
            "",
            "tax_expl_" . $a_postvar
        );
        $this->explorer_gui->setSelectMode($a_postvar . "_sel", $this->multi_nodes);
        $this->explorer_gui->setSkipRootNode(true);

        parent::__construct(
            ilObject::_lookupTitle($a_taxonomy_id),
            $a_postvar,
            $this->explorer_gui,
            $this->multi_nodes
        );
        $this->setType("tax_select");

        if ((int) $a_taxonomy_id == 0) {
            throw new ilTaxonomyException("No taxonomy ID passed to ilTaxSelectInputGUI.");
        }

        $this->setTaxonomyId((int) $a_taxonomy_id);
        $this->tax = new ilObjTaxonomy($this->getTaxonomyId());
    }

Here is the call graph for this function:

Member Function Documentation

getTaxonomyId()

ilTaxSelectInputGUI::getTaxonomyId

(

)

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

References $taxononmy_id.

Referenced by __construct().

                                   : int
    {
        return $this->taxononmy_id;
    }

Here is the caller graph for this function:

getTitleForNodeId()

ilTaxSelectInputGUI::getTitleForNodeId

(

$a_id

)

Definition at line 82 of file class.ilTaxSelectInputGUI.php.

References ilTaxonomyNode\_lookupTitle().

                                            : string
    {
        return ilTaxonomyNode::_lookupTitle((int) $a_id);
    }

Here is the call graph for this function:

setTaxonomyId()

ilTaxSelectInputGUI::setTaxonomyId

(

int

$a_val

)

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

Referenced by __construct().

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

Here is the caller graph for this function:

Field Documentation

$multi_nodes

bool ilTaxSelectInputGUI::$multi_nodes

protected

Definition at line 26 of file class.ilTaxSelectInputGUI.php.

$tax

ilObjTaxonomy ilTaxSelectInputGUI::$tax

protected

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

$taxononmy_id

int ilTaxSelectInputGUI::$taxononmy_id

protected

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

Referenced by getTaxonomyId().

---

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

• components/ILIAS/Taxonomy/classes/class.ilTaxSelectInputGUI.php