Select explorer tree nodes input GUI. More...

Inheritance diagram for ilExplorerSelectInputGUI:

Collaboration diagram for ilExplorerSelectInputGUI:

Public Member Functions
	__construct ($a_title, $a_postvar, $a_explorer_gui, $a_multi=false)
	Constructor. More...

	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)
	Set Value. More...

	getValue ()
	Get Value. More...

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

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

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

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

	getTableFilterHTML ()
	Get HTML for table filter. More...

Public Member Functions inherited from ilFormPropertyGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	executeCommand ()
	Execute command. More...

	getType ()
	Get Type. More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setPostVar ($a_postvar)
	Set Post Variable. More...

	getPostVar ()
	Get Post Variable. More...

	getFieldId ()
	Get Post Variable. More...

	setInfo ($a_info)
	Set Information Text. More...

	getInfo ()
	Get Information Text. More...

	setAlert ($a_alert)
	Set Alert Text. More...

	getAlert ()
	Get Alert Text. More...

	setRequired ($a_required)
	Set Required. More...

	getRequired ()
	Get Required. More...

	setDisabled ($a_disabled)
	Set Disabled. More...

	getDisabled ()
	Get Disabled. More...

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

	setParentForm ($a_parentform)
	Set Parent Form. More...

	getParentForm ()
	Get Parent Form. More...

	setParent ($a_val)
	Set Parent GUI object. More...

	getParent ()
	Get Parent GUI object. More...

	getSubForm ()
	Get sub form html. More...

	hideSubForm ()
	Sub form hidden on init? More...

	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders) More...

	getHiddenTitle ()
	Get hidden title. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. More...

	serializeData ()
	serialize data More...

	unserializeData ($a_data)
	unserialize data More...

	writeToSession ()
	Write to session. More...

	clearFromSession ()
	Clear session value. More...

	readFromSession ()
	Read from session. More...

	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties) More...

	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi. More...

	getMulti ()
	Get Multi. More...

	setMultiValues (array $a_values)
	Set multi values. More...

	getMultiValues ()
	Get multi values. More...

	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...

	stripSlashesAddSpaceFallback ($a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...

	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...

Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...

	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

Protected Attributes inherited from ilFormPropertyGUI
	$type

	$title

	$postvar

	$info

	$alert

	$required = false

	$parentgui

	$parentform

	$hidden_title = ""

	$multi = false

	$multi_sortable = false

	$multi_addremove = true

	$multi_values

Detailed Description

Select explorer tree nodes input GUI.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented in ilRepositorySelector2InputGUI.

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

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

References $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: boolean Input ok, true/false

Reimplemented from ilFormPropertyGUI.

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

        {
                global $lng;
                
                // sanitize
                if ($this->multi_nodes)
                {
                        if (!is_array($_POST[$this->getPostVar()]))
                        {
                                $_POST[$this->getPostVar()] = array();
                        }
                        
                        foreach ($_POST[$this->getPostVar()] as $k => $v)
                        {
                                $_POST[$this->getPostVar()][$k] = ilUtil::stripSlashes($v);
                        }
                }
                else
                {
                        $_POST[$this->getPostVar()] = ilUtil::stripSlashes($_POST[$this->getPostVar()]);
                }
                
                // check required
                if ($this->getRequired())
                {
                        if ((!$this->multi_nodes && trim($_POST[$this->getPostVar()]) == "") ||
                                ($this->multi_nodes && count($_POST[$this->getPostVar()]) == 0))
                        {
                                $this->setAlert($lng->txt("msg_input_is_required"));
                                return false;
                        }
                }
                return true;
        }

References $_POST, $lng, ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), and ilUtil\stripSlashes().

Here is the call graph for this function:

◆ getExplHandleCmd()

ilExplorerSelectInputGUI::getExplHandleCmd ( )

Get explorer handle command function.

Parameters

return

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

        {
                return "handleExplorerCommand";
        }

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

Here is the caller graph for this function:

◆ getTableFilterHTML()

ilExplorerSelectInputGUI::getTableFilterHTML ( )

Get HTML for table filter.

Implements ilTableFilterItem.

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

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

References $html, and 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.

Parameters

return

Reimplemented in ilRepositorySelector2InputGUI, and ilTaxSelectInputGUI.

Referenced by render().

Here is the caller graph for this function:

◆ getValue()

ilExplorerSelectInputGUI::getValue ( )

Get Value.

Returns: mixed tax node id or array of node ids (multi mode)

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

        {
                return $this->value;
        }

Referenced by render().

Here is the caller graph for this function:

◆ handleExplorerCommand()

ilExplorerSelectInputGUI::handleExplorerCommand ( )

Handle explorer command.

Reimplemented in ilRepositorySelector2InputGUI.

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

        {
                $this->explorer_gui->handleCommand();
        }

◆ insert()

ilExplorerSelectInputGUI::insert ( & $a_tpl )

Insert property html.

Parameters

ilTemplate

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

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

References render().

Here is the call graph for this function:

◆ render()

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

Render item.

Reimplemented in ilRepositorySelector2InputGUI.

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

        {
                global $lng;
                
                include_once("./Services/YUI/classes/class.ilYuiUtil.php");
                ilYuiUtil::initPanel();
                $GLOBALS["tpl"]->addJavascript("./Services/UIComponent/Explorer2/js/Explorer2.js");
                
                $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);
                }
                else if ($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());
//              $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();
                
                include_once "Services/UIComponent/Button/classes/class.ilLinkButton.php";
                
                $button = ilLinkButton::getInstance();
                $button->setCaption("select");
                $button->addCSSClass("ilExplSelectInputButS");
                $button->setOmitPreventDoubleSubmission(true);          
                $top_tb->addButtonInstance($button);
                
                $button = ilLinkButton::getInstance();
                $button->setCaption("cancel");
                $button->addCSSClass("ilExplSelectInputButC");
                $button->setOmitPreventDoubleSubmission(true);          
                $top_tb->addButtonInstance($button);
                
                // :TODO: we should probably clone the buttons properly
                $tpl->setVariable("TOP_TB", $top_tb->getHTML());
                $tpl->setVariable("BOT_TB", $top_tb->getHTML());
 
                //$tpl->setVariable("HREF_SELECT",
                //      $ilCtrl->getLinkTargetByClass(array($parent_gui, "ilformpropertydispatchgui", "ilrepositoryselectorinputgui"),
                //      "showRepositorySelection"));
 
                /*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();
        }

References $GLOBALS, $lng, $tpl, ilFormPropertyGUI\getFieldId(), ilLinkButton\getInstance(), ilFormPropertyGUI\getPostVar(), getTitleForNodeId(), getValue(), and ilYuiUtil\initPanel().

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 )

Set Value.

Parameters

mixed tax node id or array of node ids (multi mode)

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

        {
                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 ( $a_values )

Set value by array.

Parameters

array $a_values value array

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

        {               
                $this->setValue($a_values[$this->getPostVar()]);
        }

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

Here is the call graph for this function:

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getExplHandleCmd()

◆ getTableFilterHTML()

◆ getTitleForNodeId()

◆ getValue()

◆ handleExplorerCommand()

◆ insert()

◆ render()

◆ setValue()

◆ setValueByArray()