ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilFileInputGUI Class Reference

This class represents a file property in a property form. More...

+ Inheritance diagram for ilFileInputGUI:
+ Collaboration diagram for ilFileInputGUI:

Public Member Functions

 __construct ($a_title="", $a_postvar="")
 Constructor. More...
 
 setValueByArray ($a_values)
 Set value by array. More...
 
 setValue ($a_value)
 Set Value. More...
 
 getValue ()
 Get Value. More...
 
 setSize ($a_size)
 Set Size. More...
 
 getSize ()
 Get Size. More...
 
 setFilename ($a_val)
 Set filename value (if filename selection is enabled) More...
 
 getFilename ()
 Get Value. More...
 
 setSuffixes ($a_suffixes)
 Set Accepted Suffixes. More...
 
 getSuffixes ()
 Get Accepted Suffixes. More...
 
 setForbiddenSuffixes ($a_suffixes)
 Set forbidden Suffixes. More...
 
 getForbiddenSuffixes ()
 Get Accepted Suffixes. More...
 
 setPending ($a_val)
 Set pending filename value. More...
 
 getPending ()
 Get pending filename. More...
 
 enableFileNameSelection ($a_post_var)
 If enabled, users get the possibility to enter a filename for the uploaded file. More...
 
 isFileNameSelectionEnabled ()
 Check if filename selection is enabled. More...
 
 getFileNamePostVar ()
 Get file name post var. More...
 
 setALlowDeletion ($a_val)
 Set allow deletion. More...
 
 getALlowDeletion ()
 Get allow deletion. More...
 
 checkInput ()
 Check input, strip slashes etc. More...
 
 render ($a_mode="")
 Render html. More...
 
 insert (&$a_tpl)
 Insert property html. More...
 
 getDeletionFlag ()
 Get deletion flag. More...
 
 getToolbarHTML ()
 Get HTML for toolbar. More...
 
 setPersonalWorkspaceQuotaCheck ($a_value)
 
- Public Member Functions inherited from ilSubEnabledFormPropertyGUI
 addSubItem ($a_item)
 Add Subitem. More...
 
 getSubItems ()
 Get Subitems. More...
 
 getSubInputItemsRecursive ()
 returns a flat array of possibly existing subitems recursively More...
 
 checkSubItemsInput ()
 Check SubItems. More...
 
 getSubForm ()
 Get sub form html. More...
 
 getItemByPostVar ($a_post_var)
 Get item by post var. 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...
 
 getToolbarHTML ()
 Get input item HTML to be inserted into ilToolbarGUI. More...
 

Protected Member Functions

 outputSuffixes ($a_tpl, $a_block="allowed_suffixes")
 
 getMaxFileSizeString ()
 
- Protected Member Functions inherited from ilFormPropertyGUI
 setType ($a_type)
 Set Type. More...
 
 getMultiIconsHTML ()
 Get HTML for multiple value icons. More...
 

Protected Attributes

 $size = 40
 
 $pending
 
 $allow_deletion
 
 $forbidden_suffixes = array()
 
- Protected Attributes inherited from ilSubEnabledFormPropertyGUI
 $sub_items = array()
 
- 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
 

Static Protected Attributes

static $check_wsp_quota
 

Private Attributes

 $filename
 
 $filename_post
 

Detailed Description

This class represents a file property in a property form.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 14 of file class.ilFileInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilFileInputGUI::__construct (   $a_title = "",
  $a_postvar = "" 
)

Constructor.

Parameters
string$a_titleTitle
string$a_postvarPost Variable

Reimplemented from ilFormPropertyGUI.

Reimplemented in ilImagemapFileInputGUI, ilDragDropFileInputGUI, ilFileWizardInputGUI, ilFlashFileInputGUI, and ilImageFileInputGUI.

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

36 {
37 global $lng;
38
39 parent::__construct($a_title, $a_postvar);
40 $this->setType("file");
41 $this->setHiddenTitle("(".$lng->txt("form_file_input").")");
42 }
setType($a_type)
Set Type.
setHiddenTitle($a_val)
Set hidden title (for screenreaders)
global $lng
Definition: privfeed.php:40

References $lng, ilFormPropertyGUI\setHiddenTitle(), and ilFormPropertyGUI\setType().

+ Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilFileInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns
boolean Input ok, true/false

Reimplemented from ilFormPropertyGUI.

Reimplemented in ilImagemapFileInputGUI, ilDragDropFileInputGUI, ilFileWizardInputGUI, and ilFlashFileInputGUI.

Definition at line 241 of file class.ilFileInputGUI.php.

242 {
243 global $lng;
244
245 // #18756
246 if($this->getDisabled())
247 {
248 return true;
249 }
250
251 // if no information is received, something went wrong
252 // this is e.g. the case, if the post_max_size has been exceeded
253 if (!is_array($_FILES[$this->getPostVar()]))
254 {
255 $this->setAlert($lng->txt("form_msg_file_size_exceeds"));
256 return false;
257 }
258
259
260 $_FILES[$this->getPostVar()]["name"] = ilUtil::stripSlashes($_FILES[$this->getPostVar()]["name"]);
261
262 include_once("./Services/Utilities/classes/class.ilStr.php");
263 $_FILES[$this->getPostVar()]["name"] = ilStr::normalizeUtf8String($_FILES[$this->getPostVar()]["name"]);
264
265 // remove trailing '/'
266 while (substr($_FILES[$this->getPostVar()]["name"],-1) == '/')
267 {
268 $_FILES[$this->getPostVar()]["name"] = substr($_FILES[$this->getPostVar()]["name"],0,-1);
269 }
270
271 $filename = $_FILES[$this->getPostVar()]["name"];
272 $filename_arr = pathinfo($_FILES[$this->getPostVar()]["name"]);
273 $suffix = $filename_arr["extension"];
274 $mimetype = $_FILES[$this->getPostVar()]["type"];
275 $size_bytes = $_FILES[$this->getPostVar()]["size"];
276 $temp_name = $_FILES[$this->getPostVar()]["tmp_name"];
277 $error = $_FILES[$this->getPostVar()]["error"];
278 $_POST[$this->getPostVar()] = $_FILES[$this->getPostVar()];
279
280 // error handling
281 if ($error > 0)
282 {
283 switch ($error)
284 {
285 case UPLOAD_ERR_INI_SIZE:
286 $this->setAlert($lng->txt("form_msg_file_size_exceeds"));
287 return false;
288 break;
289
290 case UPLOAD_ERR_FORM_SIZE:
291 $this->setAlert($lng->txt("form_msg_file_size_exceeds"));
292 return false;
293 break;
294
295 case UPLOAD_ERR_PARTIAL:
296 $this->setAlert($lng->txt("form_msg_file_partially_uploaded"));
297 return false;
298 break;
299
300 case UPLOAD_ERR_NO_FILE:
301 if ($this->getRequired())
302 {
303 if (!strlen($this->getValue()))
304 {
305 $this->setAlert($lng->txt("form_msg_file_no_upload"));
306 return false;
307 }
308 }
309 break;
310
311 case UPLOAD_ERR_NO_TMP_DIR:
312 $this->setAlert($lng->txt("form_msg_file_missing_tmp_dir"));
313 return false;
314 break;
315
316 case UPLOAD_ERR_CANT_WRITE:
317 $this->setAlert($lng->txt("form_msg_file_cannot_write_to_disk"));
318 return false;
319 break;
320
321 case UPLOAD_ERR_EXTENSION:
322 $this->setAlert($lng->txt("form_msg_file_upload_stopped_ext"));
323 return false;
324 break;
325 }
326 }
327
328 // check suffixes
329 if ($_FILES[$this->getPostVar()]["tmp_name"] != "")
330 {
331 if (is_array($this->forbidden_suffixes) && in_array(strtolower($suffix), $this->forbidden_suffixes))
332 {
333 $this->setAlert($lng->txt("form_msg_file_type_is_not_allowed")." (".$suffix.")");
334 return false;
335 }
336 if (is_array($this->getSuffixes()) && count($this->getSuffixes()) > 0)
337 {
338 if (!in_array(strtolower($suffix), $this->getSuffixes()))
339 {
340 $this->setAlert($lng->txt("form_msg_file_wrong_file_type"));
341 return false;
342 }
343 }
344 }
345
346 // virus handling
347 if ($_FILES[$this->getPostVar()]["tmp_name"] != "")
348 {
349 $vir = ilUtil::virusHandling($temp_name, $filename);
350 if ($vir[0] == false)
351 {
352 $this->setAlert($lng->txt("form_msg_file_virus_found")."<br />".$vir[1]);
353 return false;
354 }
355 }
356
357 return true;
358 }
getSuffixes()
Get Accepted Suffixes.
getPostVar()
Get Post Variable.
setAlert($a_alert)
Set Alert Text.
normalizeUtf8String($a_str)
Normalize UTF8 string.
static virusHandling($a_file, $a_orig_name="", $a_clean=true)
scan file for viruses and clean files if possible
static stripSlashes($a_str, $a_strip_html=true, $a_allow="")
strip slashes if magic qoutes is enabled
$_POST['username']
Definition: cron.php:12

References $_POST, $filename, $lng, ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), getSuffixes(), getValue(), ilStr\normalizeUtf8String(), ilFormPropertyGUI\setAlert(), ilUtil\stripSlashes(), and ilUtil\virusHandling().

+ Here is the call graph for this function:

◆ enableFileNameSelection()

ilFileInputGUI::enableFileNameSelection (   $a_post_var)

If enabled, users get the possibility to enter a filename for the uploaded file.

@access public

Parameters
stringpost variable

Definition at line 187 of file class.ilFileInputGUI.php.

188 {
189 $this->filename_selection = true;
190 $this->filename_post = $a_post_var;
191 }

◆ getALlowDeletion()

ilFileInputGUI::getALlowDeletion ( )

Get allow deletion.

Returns
boolean allow deletion

Reimplemented in ilImageFileInputGUI.

Definition at line 231 of file class.ilFileInputGUI.php.

232 {
234 }

References $allow_deletion.

Referenced by render().

+ Here is the caller graph for this function:

◆ getDeletionFlag()

ilFileInputGUI::getDeletionFlag ( )

Get deletion flag.

Reimplemented in ilFlashFileInputGUI, and ilImageFileInputGUI.

Definition at line 529 of file class.ilFileInputGUI.php.

530 {
531 if ($_POST[$this->getPostVar()."_delete"])
532 {
533 return true;
534 }
535 return false;
536 }

References $_POST, and ilFormPropertyGUI\getPostVar().

+ Here is the call graph for this function:

◆ getFilename()

ilFileInputGUI::getFilename ( )

Get Value.

Returns
string Value

Definition at line 113 of file class.ilFileInputGUI.php.

114 {
115 return $this->filename;
116 }

References $filename.

Referenced by render().

+ Here is the caller graph for this function:

◆ getFileNamePostVar()

ilFileInputGUI::getFileNamePostVar ( )

Get file name post var.

@access public

Parameters
stringfile name post var

Definition at line 211 of file class.ilFileInputGUI.php.

212 {
214 }

References $filename_post.

Referenced by render(), and setValueByArray().

+ Here is the caller graph for this function:

◆ getForbiddenSuffixes()

ilFileInputGUI::getForbiddenSuffixes ( )

Get Accepted Suffixes.

Returns
array forbidden Suffixes

Definition at line 155 of file class.ilFileInputGUI.php.

156 {
158 }

References $forbidden_suffixes.

◆ getMaxFileSizeString()

ilFileInputGUI::getMaxFileSizeString ( )
protected

Definition at line 499 of file class.ilFileInputGUI.php.

500 {
501 // get the value for the maximal uploadable filesize from the php.ini (if available)
502 $umf = ini_get("upload_max_filesize");
503 // get the value for the maximal post data from the php.ini (if available)
504 $pms = ini_get("post_max_size");
505
506 //convert from short-string representation to "real" bytes
507 $multiplier_a=array("K"=>1024, "M"=>1024*1024, "G"=>1024*1024*1024);
508
509 $umf_parts=preg_split("/(\d+)([K|G|M])/", $umf, -1, PREG_SPLIT_DELIM_CAPTURE|PREG_SPLIT_NO_EMPTY);
510 $pms_parts=preg_split("/(\d+)([K|G|M])/", $pms, -1, PREG_SPLIT_DELIM_CAPTURE|PREG_SPLIT_NO_EMPTY);
511
512 if (count($umf_parts) == 2) { $umf = $umf_parts[0]*$multiplier_a[$umf_parts[1]]; }
513 if (count($pms_parts) == 2) { $pms = $pms_parts[0]*$multiplier_a[$pms_parts[1]]; }
514
515 // use the smaller one as limit
516 $max_filesize = min($umf, $pms);
517
518 if (!$max_filesize) $max_filesize=max($umf, $pms);
519
520 //format for display in mega-bytes
521 $max_filesize = sprintf("%.1f MB",$max_filesize/1024/1024);
522
523 return $max_filesize;
524 }
echo;exit;}function LogoutNotification($SessionID) { global $ilDB; $q="SELECT session_id, data FROM usr_session WHERE expires > (\w+)\|/" PREG_SPLIT_NO_EMPTY PREG_SPLIT_DELIM_CAPTURE

References PREG_SPLIT_DELIM_CAPTURE.

◆ getPending()

ilFileInputGUI::getPending ( )

Get pending filename.

Returns
string Value

Definition at line 175 of file class.ilFileInputGUI.php.

176 {
177 return $this->pending;
178 }

References $pending.

Referenced by ilImageFileInputGUI\insert(), and render().

+ Here is the caller graph for this function:

◆ getSize()

ilFileInputGUI::getSize ( )

Get Size.

Returns
int Size

Definition at line 93 of file class.ilFileInputGUI.php.

94 {
95 return $this->size;
96 }

References $size.

Referenced by render().

+ Here is the caller graph for this function:

◆ getSuffixes()

ilFileInputGUI::getSuffixes ( )

Get Accepted Suffixes.

Returns
array Accepted Suffixes

Definition at line 135 of file class.ilFileInputGUI.php.

136 {
137 return $this->suffixes;
138 }

Referenced by ilImagemapFileInputGUI\checkInput(), checkInput(), ilFileWizardInputGUI\checkInput(), ilFlashFileInputGUI\checkInput(), outputSuffixes(), and ilDragDropFileInputGUI\render().

+ Here is the caller graph for this function:

◆ getToolbarHTML()

ilFileInputGUI::getToolbarHTML ( )

Get HTML for toolbar.

Implements ilToolbarItem.

Definition at line 541 of file class.ilFileInputGUI.php.

542 {
543 $html = $this->render("toolbar");
544 return $html;
545 }
render($a_mode="")
Render html.
$html
Definition: example_001.php:87

References $html, and render().

+ Here is the call graph for this function:

◆ getValue()

ilFileInputGUI::getValue ( )

Get Value.

Returns
string Value

Reimplemented in ilFlashFileInputGUI.

Definition at line 73 of file class.ilFileInputGUI.php.

74 {
75 return $this->value;
76 }

Referenced by ilImagemapFileInputGUI\checkInput(), checkInput(), ilImagemapFileInputGUI\insert(), ilImageFileInputGUI\insert(), and render().

+ Here is the caller graph for this function:

◆ insert()

ilFileInputGUI::insert ( $a_tpl)

Insert property html.

Returns
int Size

Reimplemented in ilImagemapFileInputGUI, ilFileWizardInputGUI, ilFlashFileInputGUI, and ilImageFileInputGUI.

Definition at line 470 of file class.ilFileInputGUI.php.

471 {
472 $html = $this->render();
473
474 $a_tpl->setCurrentBlock("prop_generic");
475 $a_tpl->setVariable("PROP_GENERIC", $html);
476 $a_tpl->parseCurrentBlock();
477 }

References $html, and render().

+ Here is the call graph for this function:

◆ isFileNameSelectionEnabled()

ilFileInputGUI::isFileNameSelectionEnabled ( )

Check if filename selection is enabled.

@access public

Returns
bool enabled/disabled

Definition at line 199 of file class.ilFileInputGUI.php.

200 {
201 return $this->filename_selection ? true : false;
202 }

Referenced by render().

+ Here is the caller graph for this function:

◆ outputSuffixes()

ilFileInputGUI::outputSuffixes (   $a_tpl,
  $a_block = "allowed_suffixes" 
)
protected

Definition at line 480 of file class.ilFileInputGUI.php.

481 {
482 global $lng;
483
484 if (is_array($this->getSuffixes()) && count($this->getSuffixes()) > 0)
485 {
486 $suff_str = $delim = "";
487 foreach($this->getSuffixes() as $suffix)
488 {
489 $suff_str.= $delim.".".$suffix;
490 $delim = ", ";
491 }
492 $a_tpl->setCurrentBlock($a_block);
493 $a_tpl->setVariable("TXT_ALLOWED_SUFFIXES",
494 $lng->txt("file_allowed_suffixes")." ".$suff_str);
495 $a_tpl->parseCurrentBlock();
496 }
497 }

References $lng, and getSuffixes().

Referenced by ilImagemapFileInputGUI\insert(), ilFileWizardInputGUI\insert(), ilFlashFileInputGUI\insert(), ilImageFileInputGUI\insert(), ilDragDropFileInputGUI\render(), and render().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ render()

ilFileInputGUI::render (   $a_mode = "")

Render html.

Reimplemented in ilDragDropFileInputGUI.

Definition at line 363 of file class.ilFileInputGUI.php.

364 {
365 global $lng;
366
367 $quota_exceeded = $quota_legend = false;
368 if(self::$check_wsp_quota)
369 {
370 include_once "Services/DiskQuota/classes/class.ilDiskQuotaHandler.php";
372 {
373 $lng->loadLanguageModule("file");
374 $quota_exceeded = $lng->txt("personal_workspace_quota_exceeded_warning");
375 }
376 else
377 {
378 $quota_legend = ilDiskQuotaHandler::getStatusLegend();
379 }
380 }
381
382 $f_tpl = new ilTemplate("tpl.prop_file.html", true, true, "Services/Form");
383
384
385 // show filename selection if enabled
386 if($this->isFileNameSelectionEnabled())
387 {
388 $f_tpl->setCurrentBlock('filename');
389 $f_tpl->setVariable('POST_FILENAME',$this->getFileNamePostVar());
390 $f_tpl->setVariable('VAL_FILENAME',$this->getFilename());
391 $f_tpl->setVariable('FILENAME_ID',$this->getFieldId());
392 $f_tpl->setVAriable('TXT_FILENAME_HINT',$lng->txt('if_no_title_then_filename'));
393 $f_tpl->parseCurrentBlock();
394 }
395 else
396 {
397 if (trim($this->getValue() != ""))
398 {
399 if (!$this->getDisabled() && $this->getALlowDeletion())
400 {
401 $f_tpl->setCurrentBlock("delete_bl");
402 $f_tpl->setVariable("POST_VAR_D", $this->getPostVar());
403 $f_tpl->setVariable("TXT_DELETE_EXISTING",
404 $lng->txt("delete_existing_file"));
405 $f_tpl->parseCurrentBlock();
406 }
407
408 $f_tpl->setCurrentBlock('prop_file_propval');
409 $f_tpl->setVariable('FILE_VAL', $this->getValue());
410 $f_tpl->parseCurrentBlock();
411 }
412 }
413
414 if ($a_mode != "toolbar")
415 {
416 if(!$quota_exceeded)
417 {
418 $this->outputSuffixes($f_tpl);
419
420 $f_tpl->setCurrentBlock("max_size");
421 $f_tpl->setVariable("TXT_MAX_SIZE", $lng->txt("file_notice")." ".
422 $this->getMaxFileSizeString());
423 $f_tpl->parseCurrentBlock();
424
425 if($quota_legend)
426 {
427 $f_tpl->setVariable("TXT_MAX_SIZE", $quota_legend);
428 $f_tpl->parseCurrentBlock();
429 }
430 }
431 else
432 {
433 $f_tpl->setCurrentBlock("max_size");
434 $f_tpl->setVariable("TXT_MAX_SIZE", $quota_exceeded);
435 $f_tpl->parseCurrentBlock();
436 }
437 }
438 else if($quota_exceeded)
439 {
440 return $quota_exceeded;
441 }
442
443 $pending = $this->getPending();
444 if($pending)
445 {
446 $f_tpl->setCurrentBlock("pending");
447 $f_tpl->setVariable("TXT_PENDING", $lng->txt("file_upload_pending").
448 ": ".$pending);
449 $f_tpl->parseCurrentBlock();
450 }
451
452 if ($this->getDisabled() || $quota_exceeded)
453 {
454 $f_tpl->setVariable("DISABLED",
455 " disabled=\"disabled\"");
456 }
457
458 $f_tpl->setVariable("POST_VAR", $this->getPostVar());
459 $f_tpl->setVariable("ID", $this->getFieldId());
460 $f_tpl->setVariable("SIZE", $this->getSize());
461
462 return $f_tpl->get();
463 }
static isUploadPossible($a_additional_size=null)
outputSuffixes($a_tpl, $a_block="allowed_suffixes")
isFileNameSelectionEnabled()
Check if filename selection is enabled.
getFileNamePostVar()
Get file name post var.
getPending()
Get pending filename.
getALlowDeletion()
Get allow deletion.
getFieldId()
Get Post Variable.
special template class to simplify handling of ITX/PEAR

References $lng, $pending, getALlowDeletion(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), getFilename(), getFileNamePostVar(), getPending(), ilFormPropertyGUI\getPostVar(), getSize(), ilDiskQuotaHandler\getStatusLegend(), getValue(), isFileNameSelectionEnabled(), ilDiskQuotaHandler\isUploadPossible(), and outputSuffixes().

Referenced by getToolbarHTML(), and insert().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setALlowDeletion()

ilFileInputGUI::setALlowDeletion (   $a_val)

Set allow deletion.

Parameters
boolean$a_valallow deletion

Reimplemented in ilImageFileInputGUI.

Definition at line 221 of file class.ilFileInputGUI.php.

222 {
223 $this->allow_deletion = $a_val;
224 }

◆ setFilename()

ilFileInputGUI::setFilename (   $a_val)

Set filename value (if filename selection is enabled)

Parameters
string$a_val

Definition at line 103 of file class.ilFileInputGUI.php.

104 {
105 $this->filename = $a_val;
106 }

Referenced by setValueByArray().

+ Here is the caller graph for this function:

◆ setForbiddenSuffixes()

ilFileInputGUI::setForbiddenSuffixes (   $a_suffixes)

Set forbidden Suffixes.

Parameters
array$a_suffixesforbidden Suffixes

Definition at line 145 of file class.ilFileInputGUI.php.

146 {
147 $this->forbidden_suffixes = $a_suffixes;
148 }

◆ setPending()

ilFileInputGUI::setPending (   $a_val)

Set pending filename value.

Parameters
string$a_val

Definition at line 165 of file class.ilFileInputGUI.php.

166 {
167 $this->pending = $a_val;
168 }

◆ setPersonalWorkspaceQuotaCheck()

ilFileInputGUI::setPersonalWorkspaceQuotaCheck (   $a_value)

Definition at line 547 of file class.ilFileInputGUI.php.

548 {
549 if((bool)$a_value)
550 {
551 include_once "Services/WebDAV/classes/class.ilDiskQuotaActivationChecker.php";
553 {
554 self::$check_wsp_quota = true;
555 return;
556 }
557 }
558 self::$check_wsp_quota = false;
559 }

References ilDiskQuotaActivationChecker\_isPersonalWorkspaceActive().

Referenced by ilObjBlogGUI\executeCommand(), ilObjFileGUI\executeCommand(), ilObjPortfolioGUI\executeCommand(), ilObjBlogGUI\initEditCustomForm(), and ilObjPortfolioBaseGUI\initEditCustomForm().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setSize()

ilFileInputGUI::setSize (   $a_size)

Set Size.

Parameters
int$a_sizeSize

Definition at line 83 of file class.ilFileInputGUI.php.

84 {
85 $this->size = $a_size;
86 }

◆ setSuffixes()

ilFileInputGUI::setSuffixes (   $a_suffixes)

Set Accepted Suffixes.

Parameters
array$a_suffixesAccepted Suffixes

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

126 {
127 $this->suffixes = $a_suffixes;
128 }

Referenced by ilFlashFileInputGUI\__construct(), and ilImageFileInputGUI\__construct().

+ Here is the caller graph for this function:

◆ setValue()

ilFileInputGUI::setValue (   $a_value)

Set Value.

(used for displaying file title of existing file below input field)

Parameters
string$a_valueValue

Reimplemented in ilImagemapFileInputGUI, and ilFlashFileInputGUI.

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

64 {
65 $this->value = $a_value;
66 }

Referenced by setValueByArray().

+ Here is the caller graph for this function:

◆ setValueByArray()

ilFileInputGUI::setValueByArray (   $a_values)

Set value by array.

Parameters
array$a_valuesvalue array

Reimplemented in ilImagemapFileInputGUI, and ilFlashFileInputGUI.

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

50 {
51 if (!is_array($a_values[$this->getPostVar()]))
52 {
53 $this->setValue($a_values[$this->getPostVar()]);
54 }
55 $this->setFilename($a_values[$this->getFileNamePostVar()]);
56 }
setValue($a_value)
Set Value.
setFilename($a_val)
Set filename value (if filename selection is enabled)

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

+ Here is the call graph for this function:

Field Documentation

◆ $allow_deletion

ilFileInputGUI::$allow_deletion
protected

◆ $check_wsp_quota

ilFileInputGUI::$check_wsp_quota
staticprotected

Definition at line 22 of file class.ilFileInputGUI.php.

◆ $filename

◆ $filename_post

ilFileInputGUI::$filename_post
private

Definition at line 17 of file class.ilFileInputGUI.php.

Referenced by getFileNamePostVar().

◆ $forbidden_suffixes

ilFileInputGUI::$forbidden_suffixes = array()
protected

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

Referenced by getForbiddenSuffixes().

◆ $pending

ilFileInputGUI::$pending
protected

Definition at line 19 of file class.ilFileInputGUI.php.

Referenced by getPending(), ilImageFileInputGUI\insert(), and render().

◆ $size

ilFileInputGUI::$size = 40
protected

Definition at line 18 of file class.ilFileInputGUI.php.

Referenced by getSize().


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