ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5
ilExplorerSelectInputGUI Class Reference

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...
 
 removeProhibitedCharacters ($a_text)
 Remove prohibited characters see #19159. More...
 
 stripSlashesAddSpaceFallback ($a_str)
 Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...
 

Additional Inherited Members

- 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_titleTitle
string$a_postvarPost Variable

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

References $lng, and ilFormPropertyGUI\setType().

25  {
26  global $lng;
27 
28  $this->multi_nodes = $a_multi;
29  $this->explorer_gui = $a_explorer_gui;
30 
31  parent::__construct($a_title, $a_postvar);
32  $this->setType("exp_select");
33  }
setType($a_type)
Set Type.
global $lng
Definition: privfeed.php:40
+ 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

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

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

112  {
113  global $lng;
114 
115  // sanitize
116  if ($this->multi_nodes)
117  {
118  if (!is_array($_POST[$this->getPostVar()]))
119  {
120  $_POST[$this->getPostVar()] = array();
121  }
122 
123  foreach ($_POST[$this->getPostVar()] as $k => $v)
124  {
125  $_POST[$this->getPostVar()][$k] = ilUtil::stripSlashes($v);
126  }
127  }
128  else
129  {
130  $_POST[$this->getPostVar()] = ilUtil::stripSlashes($_POST[$this->getPostVar()]);
131  }
132 
133  // check required
134  if ($this->getRequired())
135  {
136  if ((!$this->multi_nodes && trim($_POST[$this->getPostVar()]) == "") ||
137  ($this->multi_nodes && count($_POST[$this->getPostVar()]) == 0))
138  {
139  $this->setAlert($lng->txt("msg_input_is_required"));
140  return false;
141  }
142  }
143  return true;
144  }
$_POST['username']
Definition: cron.php:12
getPostVar()
Get Post Variable.
setAlert($a_alert)
Set Alert Text.
static stripSlashes($a_str, $a_strip_html=true, $a_allow="")
strip slashes if magic qoutes is enabled
global $lng
Definition: privfeed.php:40
+ Here is the call graph for this function:

◆ getExplHandleCmd()

ilExplorerSelectInputGUI::getExplHandleCmd ( )

Get explorer handle command function.

Parameters

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

Referenced by ilTaxSelectInputGUI\__construct().

42  {
43  return "handleExplorerCommand";
44  }
+ Here is the caller graph for this function:

◆ getTableFilterHTML()

ilExplorerSelectInputGUI::getTableFilterHTML ( )

Get HTML for table filter.

Implements ilTableFilterItem.

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

References $html, and render().

270  {
271  $html = $this->render("table_filter");
272  return $html;
273  }
render($a_mode="property_form")
Render item.
$html
Definition: example_001.php:87
+ 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

Referenced by handleExplorerCommand(), and 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.

Referenced by render().

92  {
93  return $this->value;
94  }
+ Here is the caller graph for this function:

◆ handleExplorerCommand()

ilExplorerSelectInputGUI::handleExplorerCommand ( )

Handle explorer command.

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

References getTitleForNodeId().

50  {
51  $this->explorer_gui->handleCommand();
52  }
+ Here is the call graph for this function:

◆ insert()

ilExplorerSelectInputGUI::insert ( $a_tpl)

Insert property html.

Parameters
ilTemplate

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

References render().

260  {
261  $a_tpl->setCurrentBlock("prop_generic");
262  $a_tpl->setVariable("PROP_GENERIC", $this->render());
263  $a_tpl->parseCurrentBlock();
264  }
render($a_mode="property_form")
Render item.
+ Here is the call graph for this function:

◆ render()

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

Render item.

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

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

Referenced by getTableFilterHTML(), and insert().

151  {
152  global $lng, $ilCtrl, $ilObjDataCache, $tree;
153 
154  include_once("./Services/YUI/classes/class.ilYuiUtil.php");
156  $GLOBALS["tpl"]->addJavascript("./Services/UIComponent/Explorer2/js/Explorer2.js");
157 
158  $tpl = new ilTemplate("tpl.prop_expl_select.html", true, true, "Services/UIComponent/Explorer2");
159 
160 
161  // set values
162  $val = $this->getValue();
163  if (is_array($val))
164  {
165  $val_txt = $sep = "";
166  foreach ($val as $v)
167  {
168  $tpl->setCurrentBlock("node_hid");
169  $tpl->setVariable("HID_NAME", $this->getPostVar()."[]");
170  $tpl->setVariable("HID_VAL", $v);
171  $tpl->parseCurrentBlock();
172  $val_txt.= $sep.$this->getTitleForNodeId($v);
173  $sep = ", ";
174  $this->explorer_gui->setNodeOpen($v);
175  $this->explorer_gui->setNodeSelected($v);
176  }
177  $tpl->setVariable("VAL_TXT", $val_txt);
178  }
179  else if ($val != "")
180  {
181  $tpl->setCurrentBlock("node_hid");
182  $tpl->setVariable("HID_NAME", $this->getPostVar());
183  $tpl->setVariable("HID_VAL", $val);
184  $tpl->parseCurrentBlock();
185  $tpl->setVariable("VAL_TXT", $this->getTitleForNodeId($val));
186  $this->explorer_gui->setNodeOpen($val);
187  $this->explorer_gui->setNodeSelected($val);
188  }
189 
190  $tpl->setVariable("POST_VAR", $this->getPostVar());
191  $tpl->setVariable("ID", $this->getFieldId());
192 // $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($this->getValue()));
193 
194  //added disabled
195  if(!$this->disabled) {
196  $tpl->setCurrentBlock("txt_select");
197  $tpl->setVariable("TXT_SELECT", $lng->txt("select"));
198  $tpl->setVariable("ID_TXT_SELECT", $this->getFieldId());
199  $tpl->parseCurrentBlock();
200 
201  $tpl->setCurrentBlock("txt_reset");
202  $tpl->setVariable("TXT_RESET", $lng->txt("reset"));
203  $tpl->setVariable("ID_TXT_RESET", $this->getFieldId());
204  $tpl->parseCurrentBlock();
205  }
206 
207  $tpl->setVariable("EXPL", $this->explorer_gui->getHTML());
208 
209  $top_tb = new ilToolbarGUI();
210 
211  include_once "Services/UIComponent/Button/classes/class.ilLinkButton.php";
212 
213  $button = ilLinkButton::getInstance();
214  $button->setCaption("select");
215  $button->addCSSClass("ilExplSelectInputButS");
216  $button->setOmitPreventDoubleSubmission(true);
217  $top_tb->addButtonInstance($button);
218 
219  $button = ilLinkButton::getInstance();
220  $button->setCaption("cancel");
221  $button->addCSSClass("ilExplSelectInputButC");
222  $button->setOmitPreventDoubleSubmission(true);
223  $top_tb->addButtonInstance($button);
224 
225  // :TODO: we should probably clone the buttons properly
226  $tpl->setVariable("TOP_TB", $top_tb->getHTML());
227  $tpl->setVariable("BOT_TB", $top_tb->getHTML());
228 
229  //$tpl->setVariable("HREF_SELECT",
230  // $ilCtrl->getLinkTargetByClass(array($parent_gui, "ilformpropertydispatchgui", "ilrepositoryselectorinputgui"),
231  // "showRepositorySelection"));
232 
233  /*if ($this->getValue() > 0 && $this->getValue() != ROOT_FOLDER_ID)
234  {
235  $tpl->setVariable("TXT_ITEM",
236  $ilObjDataCache->lookupTitle($ilObjDataCache->lookupObjId($this->getValue())));
237  }
238  else
239  {
240  $nd = $tree->getNodeData(ROOT_FOLDER_ID);
241  $title = $nd["title"];
242  if ($title == "ILIAS")
243  {
244  $title = $lng->txt("repository");
245  }
246  if (in_array($nd["type"], $this->getClickableTypes()))
247  {
248  $tpl->setVariable("TXT_ITEM", $title);
249  }
250  }*/
251 
252  return $tpl->get();
253  }
getPostVar()
Get Post Variable.
global $tpl
Definition: ilias.php:8
global $ilCtrl
Definition: ilias.php:18
getTitleForNodeId($a_id)
Get title for node id (needs to be overwritten, if explorer is not a tree eplorer.
getFieldId()
Get Post Variable.
special template class to simplify handling of ITX/PEAR
static initPanel($a_resize=false)
Init yui panel.
global $lng
Definition: privfeed.php:40
$GLOBALS['PHPCAS_CLIENT']
This global variable is used by the interface class phpCAS.
Definition: CAS.php:276
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setValue()

ilExplorerSelectInputGUI::setValue (   $a_value)

Set Value.

Parameters
mixedtax node id or array of node ids (multi mode)

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

Referenced by setValueByArray().

68  {
69  if ($this->multi_nodes && !is_array($a_value))
70  {
71  if ($a_value !== false)
72  {
73  $this->value = array($a_value);
74  }
75  else
76  {
77  $this->value = array();
78  }
79  }
80  else
81  {
82  $this->value = $a_value;
83  }
84  }
+ Here is the caller graph for this function:

◆ setValueByArray()

ilExplorerSelectInputGUI::setValueByArray (   $a_values)

Set value by array.

Parameters
array$a_valuesvalue array

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

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

102  {
103  $this->setValue($a_values[$this->getPostVar()]);
104  }
getPostVar()
Get Post Variable.
+ Here is the call graph for this function:

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