ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
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 $ilCtrl, $text, ilRTE\_replaceMediaObjectImageSrc(), ilDatePresentation\formatDate(), ilExSubmissionBaseGUI\handleTabs(), IL_CAL_UNIX, initAssignmentTextForm(), ilUtil\sendFailure(), and ilUtil\sendInfo().

Referenced by updateAssignmentTextObject().

117  {
118  global $ilCtrl;
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  // extended deadline date should not be presented anywhere
130  // see ilExAssignmentGUI::addSchedule()
131  $dl_info = ilDatePresentation::formatDate(new ilDateTime($this->assignment->getDeadline(), IL_CAL_UNIX));
132 
133  // #16151 - extended deadline warning (only after deadline passed)
134  if($this->assignment->getDeadline() < time())
135  {
136  $dl = ilDatePresentation::formatDate(new ilDateTime($this->assignment->getDeadline(),IL_CAL_UNIX));
137  $dl = '<br /><span class="warning">'.sprintf($this->lng->txt("exc_late_submission_warning"), $dl).'</span>';
138  $dl_info .= $dl;
139  }
140 
141  ilUtil::sendInfo($this->lng->txt("exc_edit_until").": ".$dl_info);
142  }
143 
144  $this->handleTabs();
145 
146  global $ilHelp;
147  $ilHelp->setScreenIdComponent("exc");
148  $ilHelp->setScreenId("text_submission");
149 
150  if(!$a_form)
151  {
152  $a_form = $this->initAssignmentTextForm();
153 
154  $files = $this->submission->getFiles();
155  if($files)
156  {
157  $files = array_shift($files);
158  if(trim($files["atext"]))
159  {
160  $text = $a_form->getItemByPostVar("atxt");
161  // mob id to mob src
162  $text->setValue(ilRTE::_replaceMediaObjectImageSrc($files["atext"], 1));
163  }
164  }
165  }
166 
167  $this->tpl->setContent($a_form->getHTML());
168  }
ilPropertyFormGUI\getItemByPostVar
getItemByPostVar($a_post_var)
Get Item by POST variable.
Definition: class.ilPropertyFormGUI.php:277
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:236
$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:4964
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
ilUtil\sendFailure
static sendFailure($a_info="", $a_keep=false)
Send Failure Message to Screen.
Definition: class.ilUtil.php:4978
$text
$text
Definition: example_020.php:127
+ 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(), 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
ilInfoScreenGUI\addProperty
addProperty($a_name, $a_value, $a_link="")
add a property to current section
Definition: class.ilInfoScreenGUI.php:220
$lng
global $lng
Definition: privfeed.php:40
+ 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, and $text.

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
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 241 of file class.ilExSubmissionTextGUI.php.

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

242  {
243  if(!$this->submission->isTutor())
244  {
245  $this->handleTabs();
246  }
247 
248  $a_form = $this->initAssignmentTextForm(true);
249 
250  $files = $this->submission->getFiles();
251  if($files)
252  {
253  $files = array_shift($files);
254  if(trim($files["atext"]))
255  {
256  if($files["late"] &&
257  !$this->submission->hasPeerReviewAccess())
258  {
259  ilUtil::sendFailure($this->lng->txt("exc_late_submission"));
260  }
261 
262  $text = $a_form->getItemByPostVar("atxt");
263  // mob id to mob src
264  $text->setValue(nl2br(ilRTE::_replaceMediaObjectImageSrc($files["atext"], 1)));
265  }
266  }
267 
268  $this->tpl->setContent($a_form->getHTML());
269  }
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:236
ilUtil\sendFailure
static sendFailure($a_info="", $a_keep=false)
Send Failure Message to Screen.
Definition: class.ilUtil.php:4978
$text
$text
Definition: example_020.php:127
+ Here is the call graph for this function:

◆ updateAssignmentTextAndReturnObject()

ilExSubmissionTextGUI::updateAssignmentTextAndReturnObject ( )

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

References updateAssignmentTextObject().

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

◆ updateAssignmentTextObject()

ilExSubmissionTextGUI::updateAssignmentTextObject (   $a_return = false)

Definition at line 175 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().

176  {
177  global $ilCtrl;
178 
179  if(!$this->submission->canSubmit())
180  {
181  ilUtil::sendFailure($this->lng->txt("exercise_time_over"), true);
182  $ilCtrl->redirect($this, "returnToParent");
183  }
184 
185  $form = $this->initAssignmentTextForm();
186 
187  // we are not using a purifier, so we have to set the valid RTE tags
188  // :TODO:
189  include_once("./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php");
190  $rte = $form->getItemByPostVar("atxt");
191  $rte->setRteTags(ilObjAdvancedEditing::_getUsedHTMLTags("exc_ass"));
192 
193  if($form->checkInput())
194  {
195  $text = trim($form->getInput("atxt"));
196 
197  $existing = $this->submission->getFiles();
198 
199  $returned_id = $this->submission->updateTextSubmission(
200  // mob src to mob id
201  ilRTE::_replaceMediaObjectImageSrc($text, 0));
202 
203  // no empty text
204  if($returned_id)
205  {
206  // #16532 - always send notifications
207  $this->handleNewUpload();
208 
209  // mob usage
210  include_once "Services/MediaObjects/classes/class.ilObjMediaObject.php";
211  $mobs = ilRTE::_getMediaObjects($text, 0);
212  foreach($mobs as $mob)
213  {
214  if(ilObjMediaObject::_exists($mob))
215  {
216  ilObjMediaObject::_removeUsage($mob, 'exca~:html', $this->submission->getUserId());
217  ilObjMediaObject::_saveUsage($mob, 'exca:html', $returned_id);
218  }
219  }
220  }
221  else
222  {
223  $this->handleRemovedUpload();
224  }
225 
226  ilUtil::sendSuccess($this->lng->txt("settings_saved"), true);
227  if($a_return)
228  {
229  $ilCtrl->redirect($this, "returnToParent");
230  }
231  else
232  {
233  $ilCtrl->redirect($this, "editAssignmentText");
234  }
235  }
236 
237  $form->setValuesByPost();
238  $this->editAssignmentTextObject($form);
239  }
ilRTE\_getMediaObjects
static _getMediaObjects($a_text, $a_direction=0)
Returns all media objects found in the passed string.
Definition: class.ilRTE.php:275
ilUtil\sendSuccess
static sendSuccess($a_info="", $a_keep=false)
Send Success Message to Screen.
Definition: class.ilUtil.php:5008
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:236
ilObjMediaObject\_removeUsage
_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:1110
$ilCtrl
global $ilCtrl
Definition: ilias.php:18
ilObjMediaObject\_saveUsage
_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:1089
ilExSubmissionBaseGUI\handleNewUpload
handleNewUpload($a_no_notifications=false)
Definition: class.ilExSubmissionBaseGUI.php:62
$mobs
$mobs
Definition: imagemanager.php:67
ilObjMediaObject\_exists
static _exists($a_id)
checks wether a lm content object with specified id exists or not
Definition: class.ilObjMediaObject.php:84
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:4978
ilObjAdvancedEditing\_getUsedHTMLTags
& _getUsedHTMLTags($a_module="")
Returns an array of all allowed HTML tags for text editing.
Definition: class.ilObjAdvancedEditing.php:165
$text
$text
Definition: example_020.php:127
+ 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: