Inheritance diagram for ilMultipleImagesInputGUI:

Collaboration diagram for ilMultipleImagesInputGUI:

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

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

	getSuffixes ()
	Get Accepted Suffixes. More...

	getImageRemovalCommand ()

	setImageRemovalCommand ($imageRemovalCommand)

	getImageUploadCommand ()

	setImageUploadCommand ($imageUploadCommand)

	isEditElementOccuranceEnabled ()

	setEditElementOccuranceEnabled ($editElementOccuranceEnabled)

	isEditElementOrderEnabled ()

	setEditElementOrderEnabled ($editElementOrderEnabled)

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

	render (string $a_mode="")

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

	getElementAddCmd ()

	setElementAddCmd (string $element_add_cmd)

	getElementRemoveCmd ()

	setElementRemoveCmd (string $element_remove_cmd)

	getElementMoveUpCommand ()

	setElementMoveUpCommand (string $element_move_up_cmd)

	getElementMoveDownCommand ()

	setElementMoveDownCommand (string $element_move_down_cmd)

	setValues ($values)

	getValues ()

	setValue ($value)

	getValue ()

	setMultiValues (array $values)

	getMultiValues ()

	setIdentifiedMultiValues ($values)

	getIdentifiedMultiValues ()

	setValueByArray (array $a_values)

	getInput ()

	checkInput ()

	onCheckInput ()

	prepareReprintable (assQuestion $question)

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...

Data Fields
const	RENDERING_TEMPLATE = 'tpl.prop_multi_image_inp.html'

const	ITERATOR_SUBFIELD_NAME = 'iteratorfield'

const	STORED_IMAGE_SUBFIELD_NAME = 'storedimage'

const	IMAGE_UPLOAD_SUBFIELD_NAME = 'imageupload'

const	FILE_DATA_INDEX_DODGING_FILE = 'dodging_file'

Data Fields inherited from ilIdentifiedMultiValuesInputGUI
const	ELEMENT_DEFAULT_ADD_CMD = 'addElement'

const	ELEMENT_DEFAULT_REMOVE_CMD = 'removeElement'

const	ELEMENT_DEFAULT_MOVE_UP_CMD = 'moveUpElement'

const	ELEMENT_DEFAULT_MOVE_DOWN_CMD = 'moveDownElement'

Protected Member Functions
	isValidFilenameInput ($filenameInput)

	valueHasContentImageSource ($value)

	fetchContentImageSourceFromValue ($value)

	valueHasContentImageTitle ($value)

	fetchContentImageTitleFromValue ($value)

	getTemplate ()

Protected Member Functions inherited from ilIdentifiedMultiValuesInputGUI
	getMultiValueSubFieldId ($identifier, $sub_field_index)

	getMultiValuePosIndexedFieldId ($identifier, $position_index)

	getMultiValuePosIndexedSubFieldId ($identifier, $sub_field_index, $position_index)

	getFieldIdFromPostVar ($temp_post_var)

	getPostVarSubField ($sub_field_index)

	getMultiValuePostVarSubField ($identifier, $sub_field_index)

	getMultiValuePostVarSubFieldPosIndexed ($identifier, $sub_field_index, $position_index)

	getMultiValuePostVarPosIndexed ($identifier, $positionIndex)

	getMultiValuePostVar ($identifier)

	buildMultiValueSubmitVar ($identifier, $position_index, $submit_cmd)

	setIdentifiedMultiValuesByArray ($a_values)

	prepareMultiValuesInput ($values)

	prepareMultiValuesSubmit ($values)

	getFormValuesManipulators ()

	addFormValuesManipulator (ilFormValuesManipulator $manipulator)

	getSubFieldCompletedPostVar ($subFieldIndex, $elem_post_var)

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)

Protected Attributes
	$editElementOccuranceEnabled = false

	$editElementOrderEnabled = false

stdClass	$dodging_files

	$suffixes = []

	$imageRemovalCommand = 'removeImage'

	$imageUploadCommand = 'uploadImage'

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

GlyphFactory	$glyph_factory

Renderer	$renderer

UploadLimitResolver	$upload_limit

Protected Attributes inherited from ilIdentifiedMultiValuesInputGUI
string	$element_add_cmd = self::ELEMENT_DEFAULT_ADD_CMD

string	$element_remove_cmd = self::ELEMENT_DEFAULT_REMOVE_CMD

string	$element_move_up_cmd = self::ELEMENT_DEFAULT_MOVE_UP_CMD

string	$element_move_down_cmd = self::ELEMENT_DEFAULT_MOVE_DOWN_CMD

	$identified_multi_values = []

	$formValuesManipulationChain = []

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...

Detailed Description

Author: Björn Heyser bheys.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilIdentifiedMultiValuesInputGUI\addFormValuesManipulator(), ilFormPropertyGUI\getPostVar(), ILIAS\Repository\lng(), renderer(), ilTextInputGUI\setSize(), and setSuffixes().

     {
         parent::__construct($a_title, $a_postvar);
 
         global $DIC;
         $this->lng = $DIC->language();
         $this->tpl = $DIC->ui()->mainTemplate();
         $this->glyph_factory = $DIC->ui()->factory()->symbol()->glyph();
         $this->renderer = $DIC->ui()->renderer();
         $this->upload_limit = $DIC['ui.upload_limit_resolver'];
 
         $this->setSuffixes(["jpg", "jpeg", "png", "gif"]);
         $this->setSize(25);
         $this->validationRegexp = "";
 
         $manipulator = new ilMultipleImagesAdditionalIndexLevelRemover();
         $manipulator->setPostVar($this->getPostVar());
         $this->addFormValuesManipulator($manipulator);
 
         $this->dodging_files = new stdClass();
 
         $manipulator = new ilMultipleImagesFileSubmissionDataCompletion($this->dodging_files);
         $this->addFormValuesManipulator($manipulator);
 
         $manipulator = new ilIdentifiedMultiFilesJsPositionIndexRemover();
         $manipulator->setPostVar($this->getPostVar());
         $this->addFormValuesManipulator($manipulator);
 
         $manipulator = new ilMultiFilesSubmitRecursiveSlashesStripper();
         $manipulator->setPostVar($this->getPostVar());
         $this->addFormValuesManipulator($manipulator);
     }

Here is the call graph for this function:

Member Function Documentation

◆ fetchContentImageSourceFromValue()

ilMultipleImagesInputGUI::fetchContentImageSourceFromValue ( $value )

protected

Parameters

$value

Returns: string

Definition at line 435 of file class.ilMultipleImagesInputGUI.php.

References ilTextInputGUI\$value, null, and valueHasContentImageSource().

Referenced by fetchContentImageTitleFromValue(), and render().

                                                                : ?string
     {
         if ($this->valueHasContentImageSource($value)) {
             return $value['src'];
         }
 
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fetchContentImageTitleFromValue()

ilMultipleImagesInputGUI::fetchContentImageTitleFromValue ( $value )

protected

Definition at line 453 of file class.ilMultipleImagesInputGUI.php.

References ilTextInputGUI\$value, fetchContentImageSourceFromValue(), and valueHasContentImageTitle().

Referenced by render().

                                                               : ?string
     {
         if ($this->valueHasContentImageTitle($value)) {
             return $value['title'];
         }
 
         return $this->fetchContentImageSourceFromValue($value);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImageRemovalCommand()

ilMultipleImagesInputGUI::getImageRemovalCommand ( )

Returns: string

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

References $imageRemovalCommand.

Referenced by render().

                                             : string
     {
         return $this->imageRemovalCommand;
     }

Here is the caller graph for this function:

◆ getImageUploadCommand()

ilMultipleImagesInputGUI::getImageUploadCommand ( )

Returns: string

Definition at line 141 of file class.ilMultipleImagesInputGUI.php.

References $imageUploadCommand.

Referenced by render().

                                            : string
     {
         return $this->imageUploadCommand;
     }

Here is the caller graph for this function:

◆ getSuffixes()

ilMultipleImagesInputGUI::getSuffixes ( )

Get Accepted Suffixes.

Returns: array Accepted Suffixes

Definition at line 117 of file class.ilMultipleImagesInputGUI.php.

References $suffixes.

Referenced by onCheckInput(), and render().

                                  : array
     {
         return $this->suffixes;
     }

Here is the caller graph for this function:

◆ getTemplate()

ilMultipleImagesInputGUI::getTemplate ( )

protected

Returns: ilTemplate

Definition at line 465 of file class.ilMultipleImagesInputGUI.php.

Referenced by render().

                                     : ilTemplate
     {
         return new ilTemplate(self::RENDERING_TEMPLATE, true, true, "components/ILIAS/TestQuestionPool");
     }

Here is the caller graph for this function:

◆ isEditElementOccuranceEnabled()

ilMultipleImagesInputGUI::isEditElementOccuranceEnabled ( )

Returns: boolean $editElementOccuranceEnabled

Definition at line 157 of file class.ilMultipleImagesInputGUI.php.

References $editElementOccuranceEnabled.

Referenced by render().

                                                    : bool
     {
         return $this->editElementOccuranceEnabled;
     }

Here is the caller graph for this function:

◆ isEditElementOrderEnabled()

ilMultipleImagesInputGUI::isEditElementOrderEnabled ( )

Returns: boolean

Definition at line 173 of file class.ilMultipleImagesInputGUI.php.

References $editElementOrderEnabled.

Referenced by render().

                                                : bool
     {
         return $this->editElementOrderEnabled;
     }

Here is the caller graph for this function:

◆ isValidFilenameInput()

ilMultipleImagesInputGUI::isValidFilenameInput ( $filenameInput )

abstractprotected

Parameters

mixed $value

Returns: bool

Referenced by setEditElementOrderEnabled().

Here is the caller graph for this function:

◆ onCheckInput()

ilMultipleImagesInputGUI::onCheckInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean $validationSuccess

Definition at line 197 of file class.ilMultipleImagesInputGUI.php.

References $filename, ilTextInputGUI\$suffix, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilIdentifiedMultiValuesInputGUI\getInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), getSuffixes(), ILIAS\Repository\lng(), ilFormPropertyGUI\setAlert(), and ilVirusScanner\virusHandling().

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

Here is the call graph for this function:

◆ render()

ilMultipleImagesInputGUI::render ( string $a_mode = "" )

Parameters

string $mode

Returns: string

Definition at line 303 of file class.ilMultipleImagesInputGUI.php.

References ilIdentifiedMultiValuesInputGUI\$identified_multi_values, $lng, ilTextInputGUI\$suffix, ilTextInputGUI\$value, ilIdentifiedMultiValuesInputGUI\buildMultiValueSubmitVar(), fetchContentImageSourceFromValue(), fetchContentImageTitleFromValue(), ILIAS\UICore\GlobalTemplate\get(), ilFormPropertyGUI\getDisabled(), ilFileUtils\getFileSizeInfo(), ilIdentifiedMultiValuesInputGUI\getIdentifiedMultiValues(), getImageRemovalCommand(), getImageUploadCommand(), ilIdentifiedMultiValuesInputGUI\getMultiValuePosIndexedSubFieldId(), ilIdentifiedMultiValuesInputGUI\getMultiValuePostVarSubFieldPosIndexed(), ilFormPropertyGUI\getPostVar(), getSuffixes(), getTemplate(), init(), isEditElementOccuranceEnabled(), isEditElementOrderEnabled(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareFormOutput(), ilIdentifiedMultiValuesInputGUI\prepareMultiValuesInput(), renderer(), ILIAS\UICore\GlobalTemplate\setCurrentBlock(), ILIAS\UICore\GlobalTemplate\setVariable(), ilLanguage\txt(), and valueHasContentImageSource().

                                                : string
     {
         $lng = $this->lng;
 
         $tpl = $this->getTemplate();
         $i = 0;
 
         $identified_multi_values = $this->prepareMultiValuesInput($this->getIdentifiedMultiValues());
         foreach ($identified_multi_values as $identifier => $value) {
             if ($this->valueHasContentImageSource($value)) {
                 $tpl->setCurrentBlock('image');
 
                 $tpl->setVariable('STORED_IMAGE_SRC', $this->fetchContentImageSourceFromValue($value));
                 $tpl->setVariable(
                     'STORED_IMAGE_ALT',
                     ilLegacyFormElementsUtil::prepareFormOutput($this->fetchContentImageTitleFromValue($value))
                 );
                 $tpl->setVariable('STORED_IMAGE_FILENAME', $this->fetchContentImageTitleFromValue($value));
                 $tpl->setVariable('STORED_IMAGE_POST_VAR', $this->getMultiValuePostVarSubFieldPosIndexed($identifier, self::STORED_IMAGE_SUBFIELD_NAME, $i));
 
                 $tpl->setVariable('TXT_DELETE_EXISTING', $lng->txt('delete_existing_file'));
                 $tpl->setVariable('IMAGE_CMD_REMOVE', $this->buildMultiValueSubmitVar($identifier, $i, $this->getImageRemovalCommand()));
 
                 $tpl->parseCurrentBlock();
             }
 
             $tpl->setCurrentBlock('addimage');
 
             $tpl->setVariable('IMAGE_BROWSE', $lng->txt('select_file'));
             $tpl->setVariable('IMAGE_ID', $this->getMultiValuePosIndexedSubFieldId($identifier, self::IMAGE_UPLOAD_SUBFIELD_NAME, $i));
             $tpl->setVariable('MAX_SIZE_WARNING', $this->lng->txt('form_msg_file_size_exceeds'));
             $tpl->setVariable('MAX_SIZE', $this->upload_limit->getPhpUploadLimitInBytes());
             $tpl->setVariable('TXT_IMAGE_SUBMIT', $lng->txt('upload'));
             $tpl->setVariable('IMAGE_CMD_UPLOAD', $this->buildMultiValueSubmitVar($identifier, $i, $this->getImageUploadCommand()));
             $tpl->setVariable('UPLOAD_IMAGE_POST_VAR', $this->getMultiValuePostVarSubFieldPosIndexed($identifier, self::IMAGE_UPLOAD_SUBFIELD_NAME, $i));
             $tpl->setVariable('COUNT_POST_VAR', $this->getMultiValuePostVarSubFieldPosIndexed($identifier, self::ITERATOR_SUBFIELD_NAME, $i));
 
             $tpl->parseCurrentBlock();
 
             if ($this->isEditElementOrderEnabled()) {
                 $tpl->setCurrentBlock('move');
                 $tpl->setVariable('UP_BUTTON', $this->renderer->render(
                     $this->glyph_factory->up()->withAction('#')
                 ));
                 $tpl->setVariable('DOWN_BUTTON', $this->renderer->render(
                     $this->glyph_factory->down()->withAction('#')
                 ));
                 $tpl->parseCurrentBlock();
             }
 
             if ($this->isEditElementOccuranceEnabled()) {
                 $tpl->setCurrentBlock('row');
                 $tpl->setVariable('ID_ADD', $this->getMultiValuePosIndexedSubFieldId($identifier, 'add', $i));
                 $tpl->setVariable('ID_REMOVE', $this->getMultiValuePosIndexedSubFieldId($identifier, 'remove', $i));
                 $tpl->setVariable('ADD_BUTTON', $this->renderer->render(
                     $this->glyph_factory->add()->withAction('#')
                 ));
                 $tpl->setVariable('REMOVE_BUTTON', $this->renderer->render(
                     $this->glyph_factory->remove()->withAction('#')
                 ));
                 $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->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'));
 
         if (!$this->getDisabled()) {
             $iterator_subfield_name = self::ITERATOR_SUBFIELD_NAME;
             $image_upload_subfield_name = self::IMAGE_UPLOAD_SUBFIELD_NAME;
 
             $init_code = <<<JS
 $.extend({}, AnswerWizardInput, IdentifiedWizardInput).init(
     {
         'fieldContainerSelector': '.ilWzdContainerImage',
         'reindexingRequiredElementsSelectors': [
             'input:hidden[name*="[{$iterator_subfield_name}]"]',
             'input:file[id*="__{$image_upload_subfield_name}__"]',
             'input:submit[name*="[{$this->getImageUploadCommand()}]"]',
             'input:submit[name*="[{$this->getImageRemovalCommand()}]"]',
             'button'
         ],
         'handleRowCleanUpCallback': function(rowElem) {
             $(rowElem).find('div.imagepresentation').remove();
             $(rowElem).find('input[type=text]').val('');
         }
     }
 );
 JS;
 
             $this->tpl->addJavascript("assets/js/answerwizardinput.js");
             $this->tpl->addJavascript("assets/js/identifiedwizardinput.js");
             $this->tpl->addOnLoadCode($init_code);
         }
 
         return $tpl->get();
     }

Here is the call graph for this function:

◆ setEditElementOccuranceEnabled()

ilMultipleImagesInputGUI::setEditElementOccuranceEnabled ( $editElementOccuranceEnabled )

Parameters

boolean $editElementOccuranceEnabled

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

References $editElementOccuranceEnabled.

                                                                                 : void
     {
         $this->editElementOccuranceEnabled = $editElementOccuranceEnabled;
     }

◆ setEditElementOrderEnabled()

ilMultipleImagesInputGUI::setEditElementOrderEnabled ( $editElementOrderEnabled )

Parameters

boolean $editElementOrderEnabled

Definition at line 181 of file class.ilMultipleImagesInputGUI.php.

References $editElementOrderEnabled, and isValidFilenameInput().

                                                                         : void
     {
         $this->editElementOrderEnabled = $editElementOrderEnabled;
     }

Here is the call graph for this function:

◆ setImageRemovalCommand()

ilMultipleImagesInputGUI::setImageRemovalCommand ( $imageRemovalCommand )

Parameters

string $imageRemovalCommand

Definition at line 133 of file class.ilMultipleImagesInputGUI.php.

References $imageRemovalCommand.

                                                                 : void
     {
         $this->imageRemovalCommand = $imageRemovalCommand;
     }

◆ setImageUploadCommand()

ilMultipleImagesInputGUI::setImageUploadCommand ( $imageUploadCommand )

Parameters

string $imageUploadCommand

Definition at line 149 of file class.ilMultipleImagesInputGUI.php.

References $imageUploadCommand.

                                                               : void
     {
         $this->imageUploadCommand = $imageUploadCommand;
     }

◆ setSuffixes()

ilMultipleImagesInputGUI::setSuffixes ( $a_suffixes )

Set Accepted Suffixes.

Parameters

array $a_suffixes Accepted Suffixes

Definition at line 107 of file class.ilMultipleImagesInputGUI.php.

Referenced by __construct().

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

Here is the caller graph for this function:

◆ valueHasContentImageSource()

ilMultipleImagesInputGUI::valueHasContentImageSource ( $value )

protected

Parameters

$value

Returns: bool

Definition at line 424 of file class.ilMultipleImagesInputGUI.php.

References ilTextInputGUI\$value.

Referenced by fetchContentImageSourceFromValue(), and render().

                                                          : bool
     {
         return is_array($value)
             && array_key_exists('src', $value)
             && $value['src'] !== '';
     }

Here is the caller graph for this function:

◆ valueHasContentImageTitle()

ilMultipleImagesInputGUI::valueHasContentImageTitle ( $value )

protected

Parameters

$value

Returns: bool

Definition at line 448 of file class.ilMultipleImagesInputGUI.php.

References ilTextInputGUI\$value.

Referenced by fetchContentImageTitleFromValue().

                                                         : bool
     {
         return isset($value['title']) && strlen($value['title']);
     }

Here is the caller graph for this function:

Field Documentation

◆ $dodging_files

stdClass ilMultipleImagesInputGUI::$dodging_files

protected

Definition at line 46 of file class.ilMultipleImagesInputGUI.php.

◆ $editElementOccuranceEnabled

ilMultipleImagesInputGUI::$editElementOccuranceEnabled = false

protected

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

Referenced by isEditElementOccuranceEnabled(), and setEditElementOccuranceEnabled().

◆ $editElementOrderEnabled

ilMultipleImagesInputGUI::$editElementOrderEnabled = false

protected

Definition at line 44 of file class.ilMultipleImagesInputGUI.php.

Referenced by isEditElementOrderEnabled(), and setEditElementOrderEnabled().

◆ $glyph_factory

GlyphFactory ilMultipleImagesInputGUI::$glyph_factory

protected

Definition at line 59 of file class.ilMultipleImagesInputGUI.php.

◆ $imageRemovalCommand

ilMultipleImagesInputGUI::$imageRemovalCommand = 'removeImage'

protected

Definition at line 53 of file class.ilMultipleImagesInputGUI.php.

Referenced by getImageRemovalCommand(), and setImageRemovalCommand().

◆ $imageUploadCommand

ilMultipleImagesInputGUI::$imageUploadCommand = 'uploadImage'

protected

Definition at line 55 of file class.ilMultipleImagesInputGUI.php.

Referenced by getImageUploadCommand(), and setImageUploadCommand().

◆ $lng

ilLanguage ilMultipleImagesInputGUI::$lng

protected

Definition at line 57 of file class.ilMultipleImagesInputGUI.php.

Referenced by render().

◆ $renderer

Renderer ilMultipleImagesInputGUI::$renderer

protected

Definition at line 60 of file class.ilMultipleImagesInputGUI.php.

◆ $suffixes

ilMultipleImagesInputGUI::$suffixes = []

protected

Definition at line 51 of file class.ilMultipleImagesInputGUI.php.

Referenced by getSuffixes().

◆ $tpl

ilGlobalTemplateInterface ilMultipleImagesInputGUI::$tpl

protected

Definition at line 58 of file class.ilMultipleImagesInputGUI.php.

◆ $upload_limit

UploadLimitResolver ilMultipleImagesInputGUI::$upload_limit

protected

Definition at line 61 of file class.ilMultipleImagesInputGUI.php.

◆ FILE_DATA_INDEX_DODGING_FILE

const ilMultipleImagesInputGUI::FILE_DATA_INDEX_DODGING_FILE = 'dodging_file'

Definition at line 34 of file class.ilMultipleImagesInputGUI.php.

◆ IMAGE_UPLOAD_SUBFIELD_NAME

const ilMultipleImagesInputGUI::IMAGE_UPLOAD_SUBFIELD_NAME = 'imageupload'

Definition at line 32 of file class.ilMultipleImagesInputGUI.php.

Referenced by ilMultipleImagesAdditionalIndexLevelRemover\isUploadSubfieldAvailable().

◆ ITERATOR_SUBFIELD_NAME

const ilMultipleImagesInputGUI::ITERATOR_SUBFIELD_NAME = 'iteratorfield'

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

Referenced by ilMultipleImagesAdditionalIndexLevelRemover\isIteratorSubfieldAvailable(), and ilMultipleImagesAdditionalIndexLevelRemover\removeAdditionalSubFieldsLevelFromSubmitValues().

◆ RENDERING_TEMPLATE

const ilMultipleImagesInputGUI::RENDERING_TEMPLATE = 'tpl.prop_multi_image_inp.html'

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

◆ STORED_IMAGE_SUBFIELD_NAME

const ilMultipleImagesInputGUI::STORED_IMAGE_SUBFIELD_NAME = 'storedimage'

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

Referenced by ilMultipleImagesAdditionalIndexLevelRemover\removeAdditionalSubFieldsLevelFromSubmitValues().

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

components/ILIAS/TestQuestionPool/classes/forms/class.ilMultipleImagesInputGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fetchContentImageSourceFromValue()

◆ fetchContentImageTitleFromValue()

◆ getImageRemovalCommand()

◆ getImageUploadCommand()

◆ getSuffixes()

◆ getTemplate()

◆ isEditElementOccuranceEnabled()

◆ isEditElementOrderEnabled()

◆ isValidFilenameInput()

◆ onCheckInput()

◆ render()

◆ setEditElementOccuranceEnabled()

◆ setEditElementOrderEnabled()

◆ setImageRemovalCommand()

◆ setImageUploadCommand()

◆ setSuffixes()

◆ valueHasContentImageSource()

◆ valueHasContentImageTitle()

Field Documentation

◆ $dodging_files

◆ $editElementOccuranceEnabled

◆ $editElementOrderEnabled

◆ $glyph_factory

◆ $imageRemovalCommand

◆ $imageUploadCommand

◆ $lng

◆ $renderer

◆ $suffixes

◆ $tpl

◆ $upload_limit

◆ FILE_DATA_INDEX_DODGING_FILE

◆ IMAGE_UPLOAD_SUBFIELD_NAME

◆ ITERATOR_SUBFIELD_NAME

◆ RENDERING_TEMPLATE

◆ STORED_IMAGE_SUBFIELD_NAME