ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
Public Member Functions | Static Public Member Functions | Protected Member Functions
ilExSubmissionTextGUI Class Reference
Modules/Exercise

Object-based submissions (ends up as static file) More...

+ Inheritance diagram for ilExSubmissionTextGUI:
+ Collaboration diagram for ilExSubmissionTextGUI:

Public Member Functions

 executeCommand ()
 
 editAssignmentTextObject (ilPropertyFormGUI $a_form=null)
 
 updateAssignmentTextAndReturnObject ()
 
 updateAssignmentTextObject ($a_return=false)
 
 showAssignmentTextObject ()
 
- Public Member Functions inherited from ilExSubmissionBaseGUI
 __construct (ilObjExercise $a_exercise, ilExSubmission $a_submission)
 
 returnToParentObject ()
 

Static Public Member Functions

static getOverviewContent (ilInfoScreenGUI $a_info, ilExSubmission $a_submission)
 
- Static Public Member Functions inherited from ilExSubmissionBaseGUI
static getOverviewContent (ilInfoScreenGUI $a_info, ilExSubmission $a_submission)
 

Protected Member Functions

 initAssignmentTextForm ($a_read_only=false)
 
- Protected Member Functions inherited from ilExSubmissionBaseGUI
 handleTabs ()
 
 handleNewUpload ($a_no_notifications=false)
 
 handleRemovedUpload ()
 

Additional Inherited Members

- Protected Attributes inherited from ilExSubmissionBaseGUI
 $exercise
 
 $submission
 
 $assignment
 

Detailed Description

Object-based submissions (ends up as static file)

Author
Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

ilExSubmissionTextGUI:

Definition at line 12 of file class.ilExSubmissionTextGUI.php.

Member Function Documentation

◆ editAssignmentTextObject()

ilExSubmissionTextGUI::editAssignmentTextObject ( ilPropertyFormGUI  $a_form = null)

Definition at line 116 of file class.ilExSubmissionTextGUI.php.

References $files, $ilCtrl, $ilUser, $text, ilRTE\_replaceMediaObjectImageSrc(), ilDatePresentation\formatDate(), ilExSubmissionBaseGUI\handleTabs(), IL_CAL_UNIX, initAssignmentTextForm(), ilUtil\sendFailure(), ilUtil\sendInfo(), and time.

Referenced by updateAssignmentTextObject().

117  {
118  global $ilCtrl, $ilUser;
119 
120  if(!$this->submission->canSubmit())
121  {
122  ilUtil::sendFailure($this->lng->txt("exercise_time_over"), true);
123  $ilCtrl->redirect($this, "returnToParent");
124  }
125 
126  $deadline = max($this->assignment->getDeadline(), $this->assignment->getExtendedDeadline());
127  if($deadline)
128  {
129  $deadline = $this->assignment->getPersonalDeadline($ilUser->getId());
130 
131  // extended deadline date should not be presented anywhere
132  // see ilExAssignmentGUI::addSchedule()
133  $dl_info = ilDatePresentation::formatDate(new ilDateTime($deadline, IL_CAL_UNIX));
134 
135  // #16151 - extended deadline warning (only after deadline passed)
136  if($deadline < time())
137  {
138  $dl = ilDatePresentation::formatDate(new ilDateTime($deadline, IL_CAL_UNIX));
139  $dl = '<br /><span class="warning">'.sprintf($this->lng->txt("exc_late_submission_warning"), $dl).'</span>';
140  $dl_info .= $dl;
141  }
142 
143  ilUtil::sendInfo($this->lng->txt("exc_edit_until").": ".$dl_info);
144  }
145 
146  $this->handleTabs();
147 
148  global $ilHelp;
149  $ilHelp->setScreenIdComponent("exc");
150  $ilHelp->setScreenId("text_submission");
151 
152  if(!$a_form)
153  {
154  $a_form = $this->initAssignmentTextForm();
155 
156  $files = $this->submission->getFiles();
157  if($files)
158  {
159  $files = array_shift($files);
160  if(trim($files["atext"]))
161  {
162  $text = $a_form->getItemByPostVar("atxt");
163  // mob id to mob src
164  $text->setValue(ilRTE::_replaceMediaObjectImageSrc($files["atext"], 1));
165  }
166  }
167  }
168 
169  $this->tpl->setContent($a_form->getHTML());
170  }
$files
$files
Definition: add-vimline.php:18
ilPropertyFormGUI\getItemByPostVar
getItemByPostVar($a_post_var)
Get Item by POST variable.
Definition: class.ilPropertyFormGUI.php:275
ilExSubmissionTextGUI\initAssignmentTextForm
initAssignmentTextForm($a_read_only=false)
Definition: class.ilExSubmissionTextGUI.php:64
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:11
ilRTE\_replaceMediaObjectImageSrc
static _replaceMediaObjectImageSrc($a_text, $a_direction=0, $nic=IL_INST_ID)
Replaces image source from mob image urls with the mob id or replaces mob id with the correct image s...
Definition: class.ilRTE.php:237
$ilCtrl
global $ilCtrl
Definition: ilias.php:18
ilUtil\sendInfo
static sendInfo($a_info="", $a_keep=false)
Send Info Message to Screen.
Definition: class.ilUtil.php:4757
ilDatePresentation\formatDate
static formatDate(ilDateTime $date)
Format a date public.
Definition: class.ilDatePresentation.php:113
ilDateTime
Date and time handling
Definition: class.ilDateTime.php:32
$ilUser
$ilUser
Definition: imgupload.php:18
ilUtil\sendFailure
static sendFailure($a_info="", $a_keep=false)
Send Failure Message to Screen.
Definition: class.ilUtil.php:4771
$text
$text
Definition: example_020.php:127
time
Add data(end) time
Method that wraps PHPs time in order to allow simulations with the workflow.
Definition: 40duplicateStyle.php:39
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ executeCommand()

ilExSubmissionTextGUI::executeCommand ( )

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

References $cmd, $ilCtrl, and ilExAssignment\TYPE_TEXT.

15  {
16  global $ilCtrl;
17 
18  if(!$this->assignment ||
19  $this->assignment->getType() != ilExAssignment::TYPE_TEXT ||
20  !$this->submission->canView())
21  {
22  return;
23  }
24 
25  $class = $ilCtrl->getNextClass($this);
26  $cmd = $ilCtrl->getCmd("showassignmenttext");
27 
28  switch($class)
29  {
30  default:
31  $this->{$cmd."Object"}();
32  break;
33  }
34  }
$cmd
$cmd
Definition: sahs_server.php:35
$ilCtrl
global $ilCtrl
Definition: ilias.php:18

◆ getOverviewContent()

static ilExSubmissionTextGUI::getOverviewContent ( ilInfoScreenGUI  $a_info,
ilExSubmission  $a_submission 
)
static

Definition at line 36 of file class.ilExSubmissionTextGUI.php.

References $ilCtrl, $lng, ilInfoScreenGUI\addProperty(), array, ilExSubmission\canSubmit(), and ilLinkButton\getInstance().

37  {
38  global $lng, $ilCtrl;
39 
40  if($a_submission->canSubmit())
41  {
42  $button = ilLinkButton::getInstance();
43  $button->setPrimary(true);
44  $button->setCaption("exc_text_assignment_edit");
45  $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExSubmissionTextGUI"), "editAssignmentText"));
46  $files_str = $button->render();
47  }
48  else
49  {
50  $button = ilLinkButton::getInstance();
51  $button->setCaption("exc_text_assignment_show");
52  $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExSubmissionTextGUI"), "showAssignmentText"));
53  $files_str = $button->render();
54  }
55 
56  $a_info->addProperty($lng->txt("exc_files_returned_text"), $files_str);
57  }
$ilCtrl
global $ilCtrl
Definition: ilias.php:18
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
ilInfoScreenGUI\addProperty
addProperty($a_name, $a_value, $a_link="")
add a property to current section
Definition: class.ilInfoScreenGUI.php:217
$lng
global $lng
Definition: privfeed.php:17
+ Here is the call graph for this function:

◆ initAssignmentTextForm()

ilExSubmissionTextGUI::initAssignmentTextForm (   $a_read_only = false)
protected

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

References $ilCtrl, $text, and array.

Referenced by editAssignmentTextObject(), showAssignmentTextObject(), and updateAssignmentTextObject().

65  {
66  global $ilCtrl;
67 
68  include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
69  $form = new ilPropertyFormGUI();
70  $form->setTitle($this->lng->txt("exc_assignment")." \"".$this->assignment->getTitle()."\"");
71 
72  if(!$a_read_only)
73  {
74  $text = new ilTextAreaInputGUI($this->lng->txt("exc_your_text"), "atxt");
75  $text->setRequired((bool)$this->submission->getAssignment()->getMandatory());
76  $text->setRows(40);
77  $form->addItem($text);
78 
79  // custom rte tags
80  $text->setUseRte(true);
81  $text->setRTESupport($this->submission->getUserId(), "exca~", "exc_ass");
82 
83  // see ilObjForumGUI
84  $text->disableButtons(array(
85  'charmap',
86  'undo',
87  'redo',
88  'justifyleft',
89  'justifycenter',
90  'justifyright',
91  'justifyfull',
92  'anchor',
93  'fullscreen',
94  'cut',
95  'copy',
96  'paste',
97  'pastetext',
98  // 'formatselect' #13234
99  ));
100 
101  $form->setFormAction($ilCtrl->getFormAction($this, "updateAssignmentText"));
102  $form->addCommandButton("updateAssignmentTextAndReturn", $this->lng->txt("save_return"));
103  $form->addCommandButton("updateAssignmentText", $this->lng->txt("save"));
104  }
105  else
106  {
107  $form->setFormAction($ilCtrl->getFormAction($this, "returnToParent"));
108  $text = new ilNonEditableValueGUI($this->lng->txt("exc_files_returned_text"), "atxt", true);
109  $form->addItem($text);
110  }
111  $form->addCommandButton("returnToParent", $this->lng->txt("cancel"));
112 
113  return $form;
114  }
ilPropertyFormGUI
This class represents a property form user interface.
Definition: class.ilPropertyFormGUI.php:47
$ilCtrl
global $ilCtrl
Definition: ilias.php:18
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
ilNonEditableValueGUI
This class represents a non editable value in a property form.
Definition: class.ilNonEditableValueGUI.php:13
ilTextAreaInputGUI
This class represents a text area property in a property form.
Definition: class.ilTextAreaInputGUI.php:34
$text
$text
Definition: example_020.php:127
+ Here is the caller graph for this function:

◆ showAssignmentTextObject()

ilExSubmissionTextGUI::showAssignmentTextObject ( )

Definition at line 243 of file class.ilExSubmissionTextGUI.php.

References $files, $text, ilRTE\_replaceMediaObjectImageSrc(), ilExSubmissionBaseGUI\handleTabs(), initAssignmentTextForm(), and ilUtil\sendFailure().

244  {
245  if(!$this->submission->isTutor())
246  {
247  $this->handleTabs();
248  }
249 
250  $a_form = $this->initAssignmentTextForm(true);
251 
252  $files = $this->submission->getFiles();
253  if($files)
254  {
255  $files = array_shift($files);
256  if(trim($files["atext"]))
257  {
258  if($files["late"] &&
259  !$this->submission->hasPeerReviewAccess())
260  {
261  ilUtil::sendFailure($this->lng->txt("exc_late_submission"));
262  }
263 
264  $text = $a_form->getItemByPostVar("atxt");
265  // mob id to mob src
266  $text->setValue(nl2br(ilRTE::_replaceMediaObjectImageSrc($files["atext"], 1)));
267  }
268  }
269 
270  $this->tpl->setContent($a_form->getHTML());
271  }
$files
$files
Definition: add-vimline.php:18
ilExSubmissionTextGUI\initAssignmentTextForm
initAssignmentTextForm($a_read_only=false)
Definition: class.ilExSubmissionTextGUI.php:64
ilRTE\_replaceMediaObjectImageSrc
static _replaceMediaObjectImageSrc($a_text, $a_direction=0, $nic=IL_INST_ID)
Replaces image source from mob image urls with the mob id or replaces mob id with the correct image s...
Definition: class.ilRTE.php:237
ilUtil\sendFailure
static sendFailure($a_info="", $a_keep=false)
Send Failure Message to Screen.
Definition: class.ilUtil.php:4771
$text
$text
Definition: example_020.php:127
+ Here is the call graph for this function:

◆ updateAssignmentTextAndReturnObject()

ilExSubmissionTextGUI::updateAssignmentTextAndReturnObject ( )

Definition at line 172 of file class.ilExSubmissionTextGUI.php.

References updateAssignmentTextObject().

173  {
174  $this->updateAssignmentTextObject(true);
175  }
+ Here is the call graph for this function:

◆ updateAssignmentTextObject()

ilExSubmissionTextGUI::updateAssignmentTextObject (   $a_return = false)

Definition at line 177 of file class.ilExSubmissionTextGUI.php.

References $ilCtrl, $mobs, $text, ilObjMediaObject\_exists(), ilRTE\_getMediaObjects(), ilObjAdvancedEditing\_getUsedHTMLTags(), ilObjMediaObject\_removeUsage(), ilRTE\_replaceMediaObjectImageSrc(), ilObjMediaObject\_saveUsage(), editAssignmentTextObject(), ilExSubmissionBaseGUI\handleNewUpload(), ilExSubmissionBaseGUI\handleRemovedUpload(), initAssignmentTextForm(), ilUtil\sendFailure(), and ilUtil\sendSuccess().

Referenced by updateAssignmentTextAndReturnObject().

178  {
179  global $ilCtrl;
180 
181  if(!$this->submission->canSubmit())
182  {
183  ilUtil::sendFailure($this->lng->txt("exercise_time_over"), true);
184  $ilCtrl->redirect($this, "returnToParent");
185  }
186 
187  $form = $this->initAssignmentTextForm();
188 
189  // we are not using a purifier, so we have to set the valid RTE tags
190  // :TODO:
191  include_once("./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php");
192  $rte = $form->getItemByPostVar("atxt");
193  $rte->setRteTags(ilObjAdvancedEditing::_getUsedHTMLTags("exc_ass"));
194 
195  if($form->checkInput())
196  {
197  $text = trim($form->getInput("atxt"));
198 
199  $existing = $this->submission->getFiles();
200 
201  $returned_id = $this->submission->updateTextSubmission(
202  // mob src to mob id
203  ilRTE::_replaceMediaObjectImageSrc($text, 0));
204 
205  // no empty text
206  if($returned_id)
207  {
208  // #16532 - always send notifications
209  $this->handleNewUpload();
210 
211  // mob usage
212  include_once "Services/MediaObjects/classes/class.ilObjMediaObject.php";
213  $mobs = ilRTE::_getMediaObjects($text, 0);
214  foreach($mobs as $mob)
215  {
216  if(ilObjMediaObject::_exists($mob))
217  {
218  ilObjMediaObject::_removeUsage($mob, 'exca~:html', $this->submission->getUserId());
219  ilObjMediaObject::_saveUsage($mob, 'exca:html', $returned_id);
220  }
221  }
222  }
223  else
224  {
225  $this->handleRemovedUpload();
226  }
227 
228  ilUtil::sendSuccess($this->lng->txt("settings_saved"), true);
229  if($a_return)
230  {
231  $ilCtrl->redirect($this, "returnToParent");
232  }
233  else
234  {
235  $ilCtrl->redirect($this, "editAssignmentText");
236  }
237  }
238 
239  $form->setValuesByPost();
240  $this->editAssignmentTextObject($form);
241  }
ilRTE\_getMediaObjects
static _getMediaObjects($a_text, $a_direction=0)
Returns all media objects found in the passed string.
Definition: class.ilRTE.php:277
ilUtil\sendSuccess
static sendSuccess($a_info="", $a_keep=false)
Send Success Message to Screen.
Definition: class.ilUtil.php:4801
ilObjMediaObject\_exists
static _exists($a_id, $a_reference=false, $a_type=NULL)
checks wether a lm content object with specified id exists or not
Definition: class.ilObjMediaObject.php:84
ilObjAdvancedEditing\_getUsedHTMLTags
static _getUsedHTMLTags($a_module="")
Returns an array of all allowed HTML tags for text editing.
Definition: class.ilObjAdvancedEditing.php:98
ilExSubmissionTextGUI\initAssignmentTextForm
initAssignmentTextForm($a_read_only=false)
Definition: class.ilExSubmissionTextGUI.php:64
ilObjMediaObject\_removeUsage
static _removeUsage($a_mob_id, $a_type, $a_id, $a_usage_hist_nr=0, $a_lang="-")
Remove usage of mob in another container.
Definition: class.ilObjMediaObject.php:1125
ilRTE\_replaceMediaObjectImageSrc
static _replaceMediaObjectImageSrc($a_text, $a_direction=0, $nic=IL_INST_ID)
Replaces image source from mob image urls with the mob id or replaces mob id with the correct image s...
Definition: class.ilRTE.php:237
$ilCtrl
global $ilCtrl
Definition: ilias.php:18
ilExSubmissionBaseGUI\handleNewUpload
handleNewUpload($a_no_notifications=false)
Definition: class.ilExSubmissionBaseGUI.php:62
$mobs
$mobs
Definition: imagemanager.php:71
ilExSubmissionTextGUI\editAssignmentTextObject
editAssignmentTextObject(ilPropertyFormGUI $a_form=null)
Definition: class.ilExSubmissionTextGUI.php:116
ilUtil\sendFailure
static sendFailure($a_info="", $a_keep=false)
Send Failure Message to Screen.
Definition: class.ilUtil.php:4771
$text
$text
Definition: example_020.php:127
ilObjMediaObject\_saveUsage
static _saveUsage($a_mob_id, $a_type, $a_id, $a_usage_hist_nr=0, $a_lang="-")
Save usage of mob within another container (e.g.
Definition: class.ilObjMediaObject.php:1104
+ Here is the call graph for this function:
+ Here is the caller graph for this function:
The documentation for this class was generated from the following file: