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

Inheritance diagram for ilExSubmissionTextGUI:

Collaboration diagram for ilExSubmissionTextGUI:

Public Member Functions
	__construct (ilObjExercise $a_exercise, ilExSubmission $a_submission)
	Constructor. More...

	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 ()

Protected Attributes
	$user

	$help

Protected Attributes inherited from ilExSubmissionBaseGUI
	$ctrl

	$tabs_gui

	$lng

	$tpl

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

Constructor & Destructor Documentation

◆ __construct()

ilExSubmissionTextGUI::__construct	(	ilObjExercise	$a_exercise,
		ilExSubmission	$a_submission
	)

Constructor.

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

References $DIC, and user().

     {
         global $DIC;
 
         parent::__construct($a_exercise, $a_submission);
         $this->user = $DIC->user();
         $this->help = $DIC["ilHelp"];
     }

Here is the call graph for this function:

Member Function Documentation

◆ editAssignmentTextObject()

ilExSubmissionTextGUI::editAssignmentTextObject ( ilPropertyFormGUI $a_form = null )

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

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

Referenced by updateAssignmentTextObject().

     {
         $ilCtrl = $this->ctrl;
         $ilUser = $this->user;
 
         if (!$this->submission->canSubmit()) {
             ilUtil::sendFailure($this->lng->txt("exercise_time_over"), true);
             $ilCtrl->redirect($this, "returnToParent");
         }
         
         $deadline = max($this->assignment->getDeadline(), $this->assignment->getExtendedDeadline());
         if ($deadline) {
             $deadline = $this->assignment->getPersonalDeadline($ilUser->getId());
             
             // extended deadline date should not be presented anywhere
             // see ilExAssignmentGUI::addSchedule()
             $dl_info = ilDatePresentation::formatDate(new ilDateTime($deadline, IL_CAL_UNIX));
                     
             // #16151 - extended deadline warning (only after deadline passed)
             if ($deadline < time()) {
                 $dl = ilDatePresentation::formatDate(new ilDateTime($deadline, IL_CAL_UNIX));
                 $dl = '<br /><span class="warning">' . sprintf($this->lng->txt("exc_late_submission_warning"), $dl) . '</span>';
                 $dl_info .= $dl;
             }
             
             ilUtil::sendInfo($this->lng->txt("exc_edit_until") . ": " . $dl_info);
         }
         
         $this->handleTabs();
 
         $ilHelp = $this->help;
         $ilHelp->setScreenIdComponent("exc");
         $ilHelp->setScreenId("text_submission");
 
         if (!$a_form) {
             $a_form = $this->initAssignmentTextForm();
 
             $files = $this->submission->getFiles();
             if ($files) {
                 $files = array_shift($files);
                 if (trim($files["atext"])) {
                     $text = $a_form->getItemByPostVar("atxt");
                     // mob id to mob src
                     $text->setValue(ilRTE::_replaceMediaObjectImageSrc($files["atext"], 1));
                 }
             }
         }
     
         $this->tpl->setContent($a_form->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilExSubmissionTextGUI::executeCommand ( )

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

References ilExSubmissionBaseGUI\$ctrl, $ilCtrl, and ilExAssignment\TYPE_TEXT.

     {
         $ilCtrl = $this->ctrl;
         
         if (!$this->assignment ||
             $this->assignment->getType() != ilExAssignment::TYPE_TEXT ||
             !$this->submission->canView()) {
             return;
         }
         
         $class = $ilCtrl->getNextClass($this);
         $cmd = $ilCtrl->getCmd("showassignmenttext");
         
         switch ($class) {
             default:
                 $this->{$cmd . "Object"}();
                 break;
         }
     }

◆ getOverviewContent()

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

static

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

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

     {
         global $DIC;
 
         $lng = $DIC->language();
         $ilCtrl = $DIC->ctrl();
         
         if ($a_submission->canSubmit()) {
             $button = ilLinkButton::getInstance();
             $button->setPrimary(true);
             $button->setCaption("exc_text_assignment_edit");
             $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExSubmissionTextGUI"), "editAssignmentText"));
             $files_str = $button->render();
         } else {
             $button = ilLinkButton::getInstance();
             $button->setCaption("exc_text_assignment_show");
             $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExSubmissionTextGUI"), "showAssignmentText"));
             $files_str = $button->render();
         }
 
         $a_info->addProperty($lng->txt("exc_files_returned_text"), $files_str);
     }

Here is the call graph for this function:

◆ initAssignmentTextForm()

ilExSubmissionTextGUI::initAssignmentTextForm ( $a_read_only = false )

protected

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

References ilExSubmissionBaseGUI\$ctrl, $form, $ilCtrl, ilExSubmissionBaseGUI\$lng, $text, and array.

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

     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
         $form = new ilPropertyFormGUI();
         $form->setTitle($this->lng->txt("exc_assignment") . " \"" . $this->assignment->getTitle() . "\"");
             
         if (!$a_read_only) {
             $text = new ilTextAreaInputGUI($this->lng->txt("exc_your_text"), "atxt");
             $text->setRequired((bool) $this->submission->getAssignment()->getMandatory());
             $text->setRows(40);
             $text->setMaxNumOfChars($this->assignment->getMaxCharLimit());
             $text->setMinNumOfChars($this->assignment->getMinCharLimit());
 
             if ($text->isCharLimited()) {
                 $char_msg = "";
                 if ($this->assignment->getMinCharLimit()) {
                     $char_msg .= $lng->txt("exc_min_char_limit") . ": " . $this->assignment->getMinCharLimit();
                 }
                 if ($this->assignment->getMaxCharLimit()) {
                     $char_msg .= " " . $lng->txt("exc_max_char_limit") . ": " . $this->assignment->getMaxCharLimit();
                 }
                 $text->setInfo($char_msg);
             }
 
             $form->addItem($text);
             
             // custom rte tags
             $text->setUseRte(true);
             $text->setRTESupport($this->submission->getUserId(), "exca~", "exc_ass");
             
             // see ilObjForumGUI
             $text->disableButtons(array(
                 'charmap',
                 'undo',
                 'redo',
                 'justifyleft',
                 'justifycenter',
                 'justifyright',
                 'justifyfull',
                 'anchor',
                 'fullscreen',
                 'cut',
                 'copy',
                 'paste',
                 'pastetext',
                 'code',
                 // 'formatselect' #13234
             ));
             
             $form->setFormAction($ilCtrl->getFormAction($this, "updateAssignmentText"));
             $form->addCommandButton("updateAssignmentTextAndReturn", $this->lng->txt("save_return"));
             $form->addCommandButton("updateAssignmentText", $this->lng->txt("save"));
             $form->addCommandButton("returnToParent", $this->lng->txt("cancel"));
         } else {
             $form->setFormAction($ilCtrl->getFormAction($this, "returnToParent"));
             $text = new ilNonEditableValueGUI($this->lng->txt("exc_files_returned_text"), "atxt", true);
             $form->addItem($text);
         }
         
         return $form;
     }

Here is the caller graph for this function:

◆ showAssignmentTextObject()

ilExSubmissionTextGUI::showAssignmentTextObject ( )

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

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

     {
         if (!$this->submission->isTutor()) {
             $this->handleTabs();
         }
         
         $a_form = $this->initAssignmentTextForm(true);
         
         $files = $this->submission->getFiles();
         if ($files) {
             $files = array_shift($files);
             if (trim($files["atext"])) {
                 if ($files["late"] &&
                     !$this->submission->hasPeerReviewAccess()) {
                     ilUtil::sendFailure($this->lng->txt("exc_late_submission"));
                 }
                 
                 $text = $a_form->getItemByPostVar("atxt");
                 // mob id to mob src
                 $text->setValue(nl2br(ilRTE::_replaceMediaObjectImageSrc($files["atext"], 1)));
             }
         }
     
         $this->tpl->setContent($a_form->getHTML());
     }

Here is the call graph for this function:

◆ updateAssignmentTextAndReturnObject()

ilExSubmissionTextGUI::updateAssignmentTextAndReturnObject ( )

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

References updateAssignmentTextObject().

     {
         $this->updateAssignmentTextObject(true);
     }

Here is the call graph for this function:

◆ updateAssignmentTextObject()

ilExSubmissionTextGUI::updateAssignmentTextObject ( $a_return = false )

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

References ilExSubmissionBaseGUI\$ctrl, $form, $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().

     {
         $ilCtrl = $this->ctrl;
         
         if (!$this->submission->canSubmit()) {
             ilUtil::sendFailure($this->lng->txt("exercise_time_over"), true);
             $ilCtrl->redirect($this, "returnToParent");
         }
         
         $form = $this->initAssignmentTextForm();
         
         // we are not using a purifier, so we have to set the valid RTE tags
         // :TODO:
         include_once("./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php");
         $rte = $form->getItemByPostVar("atxt");
         $rte->setRteTags(ilObjAdvancedEditing::_getUsedHTMLTags("exc_ass"));
         
         if ($form->checkInput()) {
             $text = trim($form->getInput("atxt"));
                                     
             $existing = $this->submission->getFiles();
                                                 
             $returned_id = $this->submission->updateTextSubmission(
                 // mob src to mob id
                 ilRTE::_replaceMediaObjectImageSrc($text, 0)
             );
             
             // no empty text
             if ($returned_id) {
                 // #16532 - always send notifications
                 $this->handleNewUpload();
                 
                 // mob usage
                 include_once "Services/MediaObjects/classes/class.ilObjMediaObject.php";
                 $mobs = ilRTE::_getMediaObjects($text, 0);
                 foreach ($mobs as $mob) {
                     if (ilObjMediaObject::_exists($mob)) {
                         ilObjMediaObject::_removeUsage($mob, 'exca~:html', $this->submission->getUserId());
                         ilObjMediaObject::_saveUsage($mob, 'exca:html', $returned_id);
                     }
                 }
             } else {
                 $this->handleRemovedUpload();
             }
             
             ilUtil::sendSuccess($this->lng->txt("settings_saved"), true);
             if ($a_return) {
                 $ilCtrl->redirect($this, "returnToParent");
             } else {
                 $ilCtrl->redirect($this, "editAssignmentText");
             }
         }
         
         $form->setValuesByPost();
         $this->editAssignmentTextObject($form);
     }