This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilImageWizardInputGUI:

Collaboration diagram for ilImageWizardInputGUI:

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

	setValue ($a_value)

	setSuffixes ($a_suffixes)
	Set Accepted Suffixes. More...

	getSuffixes ()
	Get Accepted Suffixes. More...

	setValues ($a_values)
	Set Values. More...

	getValues ()
	Get Values. More...

	setQuestionObject ($a_value)
	Set question object. More...

	getQuestionObject ()
	Get question object. More...

	setAllowMove ($a_allow_move)
	Set allow move. More...

	getAllowMove ()
	Get allow move. More...

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

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

Public Member Functions inherited from ilTextInputGUI
	__construct (string $a_title="", string $a_postvar="")

	setValue ($a_value)

	getValue ()

	setValidationFailureMessage (string $a_msg)

	getValidationFailureMessage ()

	setValidationRegexp (string $a_value)

	getValidationRegexp ()

	setMaxLength (?int $a_maxlength)

	getMaxLength ()

	setSize (int $a_size)

	setInlineStyle (string $a_style)

	getInlineStyle ()

	setCssClass (string $a_class)

	getCssClass ()

	setValueByArray (array $a_values)

	getSize ()

	setSuffix (string $a_value)

	getSuffix ()

	setInputType (string $a_type)
	set input type More...

	getInputType ()

	setSubmitFormOnEnter (bool $a_val)

	getSubmitFormOnEnter ()

	checkInput ()

	getInput ()

	getDataSource ()

	setDataSource (string $href, string $a_delimiter=null)

	setDataSourceSubmitOnSelection (bool $a_stat)

	getDataSourceSubmitOnSelection ()

	setDataSourceSubmitUrl (string $a_url)

	getDataSourceSubmitUrl ()

	setMultiValues (array $a_values)

	render (string $a_mode="")

	insert (ilTemplate $a_tpl)

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

	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

	setDisableHtmlAutoComplete (bool $autocomplete)

	isHtmlAutoCompleteDisabled ()

	getPostValueForComparison ()

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem (ilFormPropertyGUI $a_item)

	getSubItems ()

	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()

	getItemByPostVar (string $a_post_var)

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
	$values = array()

	$allowMove = false

	$qstObject = null

	$suffixes = array()

Protected Attributes inherited from ilTextInputGUI
	$value = null

int	$maxlength = 200

int	$size = 40

string	$validationRegexp = ""

string	$validationFailureMessage = ''

string	$suffix = ""

string	$style_css = ""

string	$css_class = ""

string	$ajax_datasource = ""

string	$ajax_datasource_delimiter = null

bool	$ajax_datasource_commit = false

string	$ajax_datasource_commit_url = ""

bool	$submit_form_on_enter = false

bool	$autocomplete_disabled = false

string	$input_type = ""

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
array	$sub_items = array()

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 This class represents a single choice wizard property in a property form.

Author: Helmut Schottmüller ilias.nosp@m.@aur.nosp@m.ealis.nosp@m..de

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilImageWizardInputGUI::__construct	(	$a_title = `""`,
		$a_postvar = `""`
	)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Definition at line 39 of file class.ilImageWizardInputGUI.php.

References ILIAS\GlobalScreen\Provider\__construct(), assQuestion\getAllowedImageMaterialFileExtensions(), ilTextInputGUI\setSize(), and setSuffixes().

     {
         parent::__construct($a_title, $a_postvar);
         $this->setSuffixes(assQuestion::getAllowedImageMaterialFileExtensions());
         $this->setSize('25');
         $this->validationRegexp = "";
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilImageWizardInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

Definition at line 143 of file class.ilImageWizardInputGUI.php.

References $DIC, $filename, $index, ilFormPropertyGUI\$lng, ilTextInputGUI\$suffix, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), getSuffixes(), ilFormPropertyGUI\setAlert(), ilArrayUtil\stripSlashesRecursive(), ilLanguage\txt(), and ilVirusScanner\virusHandling().

                                 : bool
     {
         global $DIC;
         $lng = $DIC['lng'];
 
         if (is_array($_POST[$this->getPostVar()])) {
             $_POST[$this->getPostVar()] = ilArrayUtil::stripSlashesRecursive($_POST[$this->getPostVar()]);
         }
         if (is_array($_FILES[$this->getPostVar()]['error']['image'])) {
             foreach ($_FILES[$this->getPostVar()]['error']['image'] as $index => $error) {
                 // error handling
                 if ($error > 0) {
                     switch ($error) {
                         case UPLOAD_ERR_FORM_SIZE:
                         case UPLOAD_ERR_INI_SIZE:
                             $this->setAlert($lng->txt("form_msg_file_size_exceeds"));
                             return false;
                             break;
 
                         case UPLOAD_ERR_PARTIAL:
                             $this->setAlert($lng->txt("form_msg_file_partially_uploaded"));
                             return false;
                             break;
 
                         case UPLOAD_ERR_NO_FILE:
                             if ($this->getRequired()) {
                                 if (!strlen($_POST[$this->getPostVar()]['imagename'][$index])) {
                                     $this->setAlert($lng->txt("form_msg_file_no_upload"));
                                     return false;
                                 }
                             }
                             break;
 
                         case UPLOAD_ERR_NO_TMP_DIR:
                             $this->setAlert($lng->txt("form_msg_file_missing_tmp_dir"));
                             return false;
                             break;
 
                         case UPLOAD_ERR_CANT_WRITE:
                             $this->setAlert($lng->txt("form_msg_file_cannot_write_to_disk"));
                             return false;
                             break;
 
                         case UPLOAD_ERR_EXTENSION:
                             $this->setAlert($lng->txt("form_msg_file_upload_stopped_ext"));
                             return false;
                             break;
                     }
                 }
             }
         } else {
             if ($this->getRequired()) {
                 $this->setAlert($lng->txt("form_msg_file_no_upload"));
                 return false;
             }
         }
 
         if (is_array($_FILES[$this->getPostVar()]['tmp_name']['image'])) {
             foreach ($_FILES[$this->getPostVar()]['tmp_name']['image'] as $index => $tmpname) {
                 $filename = $_FILES[$this->getPostVar()]['name']['image'][$index];
                 $filename_arr = pathinfo($filename);
                 $suffix = $filename_arr["extension"];
                 $mimetype = $_FILES[$this->getPostVar()]['type']['image'][$index];
                 $size_bytes = $_FILES[$this->getPostVar()]['size']['image'][$index];
                 // check suffixes
                 if (strlen($tmpname) && is_array($this->getSuffixes())) {
                     if (!in_array(strtolower($suffix), $this->getSuffixes())) {
                         $this->setAlert($lng->txt("form_msg_file_wrong_file_type"));
                         return false;
                     }
                 }
             }
         }
 
         if (is_array($_FILES[$this->getPostVar()]['tmp_name']['image'])) {
             foreach ($_FILES[$this->getPostVar()]['tmp_name']['image'] as $index => $tmpname) {
                 $filename = $_FILES[$this->getPostVar()]['name']['image'][$index];
                 $filename_arr = pathinfo($filename);
                 $suffix = $filename_arr["extension"];
                 $mimetype = $_FILES[$this->getPostVar()]['type']['image'][$index];
                 $size_bytes = $_FILES[$this->getPostVar()]['size']['image'][$index];
                 // virus handling
                 if (strlen($tmpname)) {
                     $vir = ilVirusScanner::virusHandling($tmpname, $filename);
                     if ($vir[0] == false) {
                         $this->setAlert($lng->txt("form_msg_file_virus_found") . "<br />" . $vir[1]);
                         return false;
                     }
                 }
             }
         }
 
         return $this->checkSubItemsInput();
     }

Here is the call graph for this function:

◆ getAllowMove()

ilImageWizardInputGUI::getAllowMove ( )

Get allow move.

Returns: boolean Allow move

Definition at line 134 of file class.ilImageWizardInputGUI.php.

References $allowMove.

Referenced by insert().

                                   : bool
     {
         return $this->allowMove;
     }

Here is the caller graph for this function:

◆ getQuestionObject()

ilImageWizardInputGUI::getQuestionObject ( )

Get question object.

Returns: object Value

Definition at line 114 of file class.ilImageWizardInputGUI.php.

References $qstObject.

                                        : ?object
     {
         return $this->qstObject;
     }

◆ getSuffixes()

ilImageWizardInputGUI::getSuffixes ( )

Get Accepted Suffixes.

Returns: array Accepted Suffixes

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

References $suffixes.

Referenced by checkInput(), and insert().

                                  : array
     {
         return $this->suffixes;
     }

Here is the caller graph for this function:

◆ getValues()

ilImageWizardInputGUI::getValues ( )

Get Values.

Returns: array Values

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

References $values.

                                : array
     {
         return $this->values;
     }

◆ insert()

ilImageWizardInputGUI::insert ( ilTemplate $a_tpl )

Insert property html.

Returns: void Size

Definition at line 242 of file class.ilImageWizardInputGUI.php.

References $DIC, $i, ilFormPropertyGUI\$lng, ilTextInputGUI\$suffix, $tpl, ilTextInputGUI\$value, ilGlyphGUI\ADD, ilGlyphGUI\DOWN, ilGlyphGUI\get(), getAllowMove(), ilFormPropertyGUI\getFieldId(), ilFileUtils\getFileSizeInfo(), ilFormPropertyGUI\getPostVar(), getSuffixes(), ilTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareFormOutput(), ilGlyphGUI\REMOVE, ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), ilLanguage\txt(), and ilGlyphGUI\UP.

                                              : void
     {
         global $DIC;
         $lng = $DIC['lng'];
 
         $tpl = new ilTemplate("tpl.prop_imagewizardinput.html", true, true, "Modules/TestQuestionPool");
         $i = 0;
         foreach ($this->values as $value) {
             if (strlen($value)) {
                 $imagename = $this->qstObject->getImagePathWeb() . $value;
                 if ($this->qstObject->getThumbSize()) {
                     if (@file_exists($this->qstObject->getImagePath() . $this->qstObject->getThumbPrefix() . $value)) {
                         $imagename = $this->qstObject->getImagePathWeb() . $this->qstObject->getThumbPrefix() . $value;
                     }
                 }
                 $tpl->setCurrentBlock('image');
                 $tpl->setVariable('SRC_IMAGE', $imagename);
                 $tpl->setVariable('IMAGE_NAME', $value);
                 $tpl->setVariable('ALT_IMAGE', ilLegacyFormElementsUtil::prepareFormOutput($value));
                 $tpl->setVariable("TXT_DELETE_EXISTING", $lng->txt("delete_existing_file"));
                 $tpl->setVariable("IMAGE_ROW_NUMBER", $i);
                 $tpl->setVariable("IMAGE_POST_VAR", $this->getPostVar());
                 $tpl->parseCurrentBlock();
             }
             $tpl->setCurrentBlock('addimage');
             $tpl->setVariable("IMAGE_BROWSE", $lng->txt('select_file'));
             $tpl->setVariable("IMAGE_ID", $this->getPostVar() . "[image][$i]");
             $tpl->setVariable("IMAGE_SUBMIT", $lng->txt("upload"));
             $tpl->setVariable("IMAGE_ROW_NUMBER", $i);
             $tpl->setVariable("IMAGE_POST_VAR", $this->getPostVar());
             $tpl->parseCurrentBlock();
 
             if ($this->getAllowMove()) {
                 $tpl->setCurrentBlock("move");
                 $tpl->setVariable("CMD_UP", "cmd[up" . $this->getFieldId() . "][$i]");
                 $tpl->setVariable("CMD_DOWN", "cmd[down" . $this->getFieldId() . "][$i]");
                 $tpl->setVariable("ID", $this->getPostVar() . "[$i]");
                 $tpl->setVariable("UP_BUTTON", ilGlyphGUI::get(ilGlyphGUI::UP));
                 $tpl->setVariable("DOWN_BUTTON", ilGlyphGUI::get(ilGlyphGUI::DOWN));
                 $tpl->parseCurrentBlock();
             }
             $tpl->setCurrentBlock("row");
             $tpl->setVariable("POST_VAR", $this->getPostVar());
             $tpl->setVariable("ROW_NUMBER", $i);
             $tpl->setVariable("ID", $this->getPostVar() . "[answer][$i]");
             $tpl->setVariable("CMD_ADD", "cmd[add" . $this->getFieldId() . "][$i]");
             $tpl->setVariable("CMD_REMOVE", "cmd[remove" . $this->getFieldId() . "][$i]");
             $tpl->setVariable("ADD_BUTTON", ilGlyphGUI::get(ilGlyphGUI::ADD));
             $tpl->setVariable("REMOVE_BUTTON", ilGlyphGUI::get(ilGlyphGUI::REMOVE));
             $tpl->parseCurrentBlock();
             $i++;
         }
 
         if (is_array($this->getSuffixes())) {
             $suff_str = $delim = "";
             foreach ($this->getSuffixes() as $suffix) {
                 $suff_str .= $delim . "." . $suffix;
                 $delim = ", ";
             }
             $tpl->setCurrentBlock('allowed_image_suffixes');
             $tpl->setVariable("TXT_ALLOWED_SUFFIXES", $lng->txt("file_allowed_suffixes") . " " . $suff_str);
             $tpl->parseCurrentBlock();
         }
         /*
         $tpl->setCurrentBlock("image_heading");
         $tpl->setVariable("ANSWER_IMAGE", $lng->txt('answer_image'));
         $tpl->parseCurrentBlock();
         */
 
         $tpl->setVariable("TXT_MAX_SIZE", ilFileUtils::getFileSizeInfo());
         $tpl->setVariable("ELEMENT_ID", $this->getPostVar());
         $tpl->setVariable("TEXT_YES", $lng->txt('yes'));
         $tpl->setVariable("TEXT_NO", $lng->txt('no'));
         $tpl->setVariable("DELETE_IMAGE_HEADER", $lng->txt('delete_image_header'));
         $tpl->setVariable("DELETE_IMAGE_QUESTION", $lng->txt('delete_image_question'));
         $tpl->setVariable("ANSWER_TEXT", $lng->txt('answer_text'));
         $tpl->setVariable("COMMANDS_TEXT", $lng->txt('actions'));
 
         $a_tpl->setCurrentBlock("prop_generic");
         $a_tpl->setVariable("PROP_GENERIC", $tpl->get());
         $a_tpl->parseCurrentBlock();
 
         global $DIC;
         $tpl = $DIC['tpl'];
         $tpl->addJavascript("./Services/Form/js/ServiceFormWizardInput.js");
         $tpl->addJavascript("./Modules/TestQuestionPool/templates/default/imagewizard.js");
     }

Here is the call graph for this function:

◆ setAllowMove()

ilImageWizardInputGUI::setAllowMove ( $a_allow_move )

Set allow move.

Parameters

boolean $a_allow_move Allow move

Definition at line 124 of file class.ilImageWizardInputGUI.php.

                                                : void
     {
         $this->allowMove = $a_allow_move;
     }

◆ setQuestionObject()

ilImageWizardInputGUI::setQuestionObject ( $a_value )

Set question object.

Parameters

object $a_value test object

Definition at line 104 of file class.ilImageWizardInputGUI.php.

                                                : void
     {
         $this->qstObject = &$a_value;
     }

◆ setSuffixes()

ilImageWizardInputGUI::setSuffixes ( $a_suffixes )

Set Accepted Suffixes.

Parameters

array $a_suffixes Accepted Suffixes

Definition at line 64 of file class.ilImageWizardInputGUI.php.

Referenced by __construct().

                                             : void
     {
         $this->suffixes = $a_suffixes;
     }

Here is the caller graph for this function:

◆ setValue()

ilImageWizardInputGUI::setValue ( $a_value )

Definition at line 47 of file class.ilImageWizardInputGUI.php.

References $index, and ilTextInputGUI\$value.

                                       : void
     {
         $this->values = array();
         if (is_array($a_value)) {
             if (is_array($a_value['count'])) {
                 foreach ($a_value['count'] as $index => $value) {
                     array_push($this->values, $a_value['imagename'][$index]);
                 }
             }
         }
     }

◆ setValues()

ilImageWizardInputGUI::setValues ( $a_values )

Set Values.

Parameters

array $a_value Value

Definition at line 84 of file class.ilImageWizardInputGUI.php.

                                         : void
     {
         $this->values = $a_values;
     }

Field Documentation

◆ $allowMove

ilImageWizardInputGUI::$allowMove = false

protected

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

Referenced by getAllowMove().

◆ $qstObject

ilImageWizardInputGUI::$qstObject = null

protected

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

Referenced by getQuestionObject().

◆ $suffixes

ilImageWizardInputGUI::$suffixes = array()

protected

Definition at line 31 of file class.ilImageWizardInputGUI.php.

Referenced by getSuffixes().

◆ $values

ilImageWizardInputGUI::$values = array()

protected

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

Referenced by getValues().

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

Modules/TestQuestionPool/classes/class.ilImageWizardInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getAllowMove()

◆ getQuestionObject()

◆ getSuffixes()

◆ getValues()

◆ insert()

◆ setAllowMove()

◆ setQuestionObject()

◆ setSuffixes()

◆ setValue()

◆ setValues()

Field Documentation

◆ $allowMove

◆ $qstObject

◆ $suffixes

◆ $values