ILIAS  trunk Revision v12.0_alpha-377-g3641b37b9db
Public Member Functions
ilImagemapCorrectionsInputGUI Class Reference
+ Inheritance diagram for ilImagemapCorrectionsInputGUI:
+ Collaboration diagram for ilImagemapCorrectionsInputGUI:

Public Member Functions

 setValueByArray (array $a_values)
 Set value by array. More...
 
 setAreasByArray ($a_areas)
 
 checkInput ()
 Check input, strip slashes etc. More...
 
 insert (ilTemplate $a_tpl)
 Insert property html. More...
 
- Public Member Functions inherited from ilImagemapFileInputGUI
 __construct ($a_title="", $a_postvar="")
 Constructor. More...
 
 setPointsUncheckedFieldEnabled ($pointsUncheckedFieldEnabled)
 
 getPointsUncheckedFieldEnabled ()
 
 setAreas ($a_areas)
 
 getLineColor ()
 
 setLineColor ($a_color)
 
 getImagePath ()
 
 setImagePath ($a_path)
 
 getImagePathWeb ()
 
 setImagePathWeb ($a_path_web)
 
 setAreasByArray ($a_areas)
 
 getAreas ()
 
 setValueByArray (array $a_values)
 Set value by array. More...
 
 setValue ($a_value)
 
 getInput ()
 
 checkInput ()
 Check input, strip slashes etc. More...
 
 insert (ilTemplate $a_tpl)
 Insert property html. More...
 
- Public Member Functions inherited from ilImageFileInputGUI
 __construct (string $a_title="", string $a_postvar="")
 
 setAllowDeletion (bool $a_val)
 
 getALlowDeletion ()
 
 setAllowCapture (bool $a_val)
 
 getAllowCapture ()
 
 setUseCache (bool $a_cache)
 Set cache. More...
 
 getUseCache ()
 
 setImage (string $a_image)
 
 getImage ()
 
 setAlt (string $a_alt)
 
 getAlt ()
 
 insert (ilTemplate $a_tpl)
 
 getDeletionFlag ()
 
- Public Member Functions inherited from ilFileInputGUI
 __construct (string $a_title="", string $a_postvar="")
 
 setValueByArray (array $a_values)
 
 setValue (string $a_value)
 Set Value. More...
 
 getValue ()
 
 setSize (int $a_size)
 
 getSize ()
 
 setFilename (string $a_val)
 
 getFilename ()
 
 setSuffixes (array $a_suffixes)
 
 getSuffixes ()
 
 setForbiddenSuffixes (array $a_suffixes)
 
 getForbiddenSuffixes ()
 
 setPending (string $a_val)
 
 getPending ()
 
 enableFileNameSelection (string $a_post_var)
 
 isFileNameSelectionEnabled ()
 
 getFileNamePostVar ()
 
 setAllowDeletion (bool $a_val)
 
 getALlowDeletion ()
 
 checkInput ()
 Check input, strip slashes etc. More...
 
 getInput ()
 
 render (string $a_mode="")
 
 insert (ilTemplate $a_tpl)
 
 getDeletionFlag ()
 
 getToolbarHTML ()
 Get input item HTML to be inserted into ilToolbarGUI. More...
 
- 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)
 Get item by post var. More...
 
- 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...
 
 getToolbarHTML ()
 Get input item HTML to be inserted into ilToolbarGUI. More...
 

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 ilFileInputGUI
 outputSuffixes (ilTemplate $a_tpl, string $a_block="allowed_suffixes")
 
 getMaxFileSizeString ()
 
 getMaxFileUploads ()
 Get number of maximum file uploads as declared in php.ini. More...
 
- 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 inherited from ilImagemapFileInputGUI
 $areas = []
 
 $image_path = ""
 
 $image_path_web = ""
 
 $line_color = ""
 
 $pointsUncheckedFieldEnabled = false
 
ilTestLegacyFormsHelper $forms_helper
 
GlyphFactory $glyph_factory
 
Renderer $renderer
 
- Protected Attributes inherited from ilImageFileInputGUI
ilGlobalTemplateInterface $tpl
 
bool $cache = false
 
string $alt = ""
 
string $image = ""
 
bool $allow_capture = false
 
- Protected Attributes inherited from ilFileInputGUI
int $size = 40
 
string $pending = ""
 
bool $allow_deletion = false
 
bool $filename_selection = false
 
array $forbidden_suffixes = []
 
array $suffixes = []
 
string $value = ""
 
FileUpload $upload_service
 
UploadLimitResolver $upload_limit
 
- 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
 

Detailed Description

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

Member Function Documentation

◆ checkInput()

ilImagemapCorrectionsInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns
boolean Input ok, true/false

Reimplemented from ilImagemapFileInputGUI.

Definition at line 52 of file class.ilImagemapCorrectionsInputGUI.php.

52 : bool
53 {
54 $data = $this->raw($this->getPostVar());
55 if (!is_array($data) || !is_array($data['coords'])) {
56 $this->setAlert($this->lng->txt('form_msg_input_is_required'));
57 return false;
58 }
59
60 $result = $this->forms_helper->checkPointsInputEnoughPositive($data['coords'], $this->getRequired());
61 if (!is_array($result)) {
62 if ($result === 'msg_input_is_required') {
63 $this->setAlert($this->lng->txt('form_msg_area_missing_points'));
64 } else {
65 $this->setAlert($this->lng->txt($result));
66 }
67 return false;
68 }
69
70 return true;
71 }

References $data, ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ILIAS\Repository\lng(), ilFormPropertyGUI\raw(), and ilFormPropertyGUI\setAlert().

+ Here is the call graph for this function:

◆ insert()

ilImagemapCorrectionsInputGUI::insert ( ilTemplate  $a_tpl)

Insert property html.

Reimplemented from ilImagemapFileInputGUI.

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

73 : void
74 {
75 global $DIC;
76 $lng = $DIC['lng'];
77
78 $template = new ilTemplate('tpl.prop_imagemapquestioncorrection_input.html', true, true, 'components/ILIAS/TestQuestionPool');
79
80 if ($this->getImage() !== '') {
81 $template->setCurrentBlock('image');
82 if (count($this->getAreas())) {
83 $preview = new ilImagemapPreview($this->getImagePath() . $this->getValue());
84 foreach ($this->getAreas() as $index => $area) {
85 $preview->addArea($index, $area->getArea(), $area->getCoords(), $area->getAnswertext(), '', '', true, $this->getLineColor());
86 }
87 $preview->createPreview();
88 $imagepath = $this->getImagePathWeb() . $preview->getPreviewFilename($this->getImagePath(), $this->getValue()) . '?img=' . time();
89 $template->setVariable('SRC_IMAGE', $imagepath);
90 } else {
91 $template->setVariable('SRC_IMAGE', $this->getImage());
92 }
93 $template->setVariable('ALT_IMAGE', $this->getAlt());
94 $template->setVariable('POST_VAR_D', $this->getPostVar());
95 $template->parseCurrentBlock();
96 }
97
98 if (is_array($this->getAreas()) && $this->getAreas()) {
99 $counter = 0;
100 foreach ($this->getAreas() as $area) {
101 if ($area->getPoints() !== '') {
102 $template->setCurrentBlock('area_points_value');
103 $template->setVariable('VALUE_POINTS', $area->getPoints());
104 $template->parseCurrentBlock();
105 }
106 if ($this->getPointsUncheckedFieldEnabled()) {
107 if ($area->getPointsUnchecked() !== '') {
108 $template->setCurrentBlock('area_points_unchecked_value');
109 $template->setVariable('VALUE_POINTS_UNCHECKED', $area->getPointsUnchecked());
110 $template->parseCurrentBlock();
111 }
112
113 $template->setCurrentBlock('area_points_unchecked_field');
114 $template->parseCurrentBlock();
115 }
116 $template->setCurrentBlock('row');
117 if ($area->getAnswertext() !== '') {
118 $template->setVariable('ANSWER_AREA', $area->getAnswertext());
119 }
120 $template->setVariable('POST_VAR_R', $this->getPostVar());
121 $template->setVariable('TEXT_SHAPE', strtoupper($area->getArea()));
122 $template->setVariable('VALUE_SHAPE', $area->getArea());
123 $coords = preg_replace("/(\d+,\d+,)/", "\$1 ", $area->getCoords());
124 $template->setVariable('VALUE_COORDINATES', $area->getCoords());
125 $template->setVariable('TEXT_COORDINATES', $coords);
126 $template->setVariable('COUNTER', $counter);
127 $template->parseCurrentBlock();
128 $counter++;
129 }
130 $template->setCurrentBlock('areas');
131 $template->setVariable('TEXT_NAME', $lng->txt('ass_imap_hint'));
132 if ($this->getPointsUncheckedFieldEnabled()) {
133 $template->setVariable('TEXT_POINTS', $lng->txt('points_checked'));
134
135 $template->setCurrentBlock('area_points_unchecked_head');
136 $template->setVariable('TEXT_POINTS_UNCHECKED', $lng->txt('points_unchecked'));
137 $template->parseCurrentBlock();
138 } else {
139 $template->setVariable('TEXT_POINTS', $lng->txt('points'));
140 }
141 $template->setVariable('TEXT_SHAPE', $lng->txt('shape'));
142 $template->setVariable('TEXT_COORDINATES', $lng->txt('coordinates'));
143 $template->setVariable('TEXT_COMMANDS', $lng->txt('actions'));
144 $template->parseCurrentBlock();
145 }
146
147 $template->setVariable('POST_VAR', $this->getPostVar());
148 $template->setVariable('ID', $this->getFieldId());
149 $template->setVariable('TXT_BROWSE', $lng->txt('select_file'));
150 $template->setVariable('TXT_MAX_SIZE', $lng->txt('file_notice') . ' ' .
151 $this->getMaxFileSizeString());
152
153 $a_tpl->setCurrentBlock('prop_generic');
154 $a_tpl->setVariable('PROP_GENERIC', $template->get());
155 $a_tpl->parseCurrentBlock();
156 }
HTML_Template_IT\setVariable
setVariable($variable, $value='')
Sets a variable value.
Definition: IT.php:544
ilImagemapPreview
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition: class.ilImagemapPreview.php:30
ilLanguage\txt
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
Definition: class.ilLanguage.php:170
ilTemplate
special template class to simplify handling of ITX/PEAR
Definition: class.ilTemplate.php:31
ilTemplate\setCurrentBlock
setCurrentBlock(string $part=ilGlobalTemplateInterface::DEFAULT_BLOCK)
Definition: class.ilTemplate.php:186
ilTemplate\parseCurrentBlock
parseCurrentBlock(string $part=ilGlobalTemplateInterface::DEFAULT_BLOCK)
Definition: class.ilTemplate.php:216
$DIC
global $DIC
Definition: shib_login.php:26
$counter
$counter
Definition: shib_logout.php:170

References $counter, $DIC, ilFormPropertyGUI\$lng, ilImageFileInputGUI\getAlt(), ilImagemapFileInputGUI\getAreas(), ilFormPropertyGUI\getFieldId(), ilImageFileInputGUI\getImage(), ilImagemapFileInputGUI\getImagePath(), ilImagemapFileInputGUI\getImagePathWeb(), ilImagemapFileInputGUI\getPointsUncheckedFieldEnabled(), ilFormPropertyGUI\getPostVar(), ilFileInputGUI\getValue(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilLanguage\txt().

+ Here is the call graph for this function:

◆ setAreasByArray()

ilImagemapCorrectionsInputGUI::setAreasByArray (   $a_areas)

Reimplemented from ilImagemapFileInputGUI.

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

34 : void
35 {
36 $points = $this->forms_helper->transformPoints($a_areas, 'points');
37 $points_unchecked = $this->forms_helper->transformPoints($a_areas, 'points_unchecked');
38
39 foreach (array_keys($this->areas) as $index) {
40 if ($points[$index] === null) {
41 return;
42 }
43
44 $points_unchecked[$index] = $this->getPointsUncheckedFieldEnabled() && isset($points_unchecked[$index])
45 ? $points_unchecked[$index] : 0.0;
46
47 $this->areas[$index]->setPointsUnchecked($points_unchecked[$index]);
48 $this->areas[$index]->setPoints($points[$index]);
49 }
50 }

References ilImagemapFileInputGUI\getPointsUncheckedFieldEnabled().

Referenced by setValueByArray().

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

◆ setValueByArray()

ilImagemapCorrectionsInputGUI::setValueByArray ( array  $a_values)

Set value by array.

Parameters
array$a_valuesvalue array

Reimplemented from ilImagemapFileInputGUI.

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

29 : void
30 {
31 $this->setAreasByArray($a_values[$this->getPostVar()]['coords']);
32 }

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

+ Here is the call graph for this function:
The documentation for this class was generated from the following file: