ilExSubmissionTextGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilExSubmissionTextGUI:

Collaboration diagram for ilExSubmissionTextGUI:

Public Member Functions
	__construct (ilObjExercise $a_exercise, ilExSubmission $a_submission)
	executeCommand ()
	editAssignmentTextObject (?ilPropertyFormGUI $a_form=null)
	updateAssignmentTextAndReturnObject ()
	updateAssignmentTextObject (bool $a_return=false)
	autoSaveObject ()
	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	getOverviewContent (ilInfoScreenGUI $a_info, ilExSubmission $a_submission)

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

Protected Attributes
ILIAS Exercise Submission SubmissionManager	$sub_manager
ilObjUser	$user
ilHelpGUI	$help
Protected Attributes inherited from ilExSubmissionBaseGUI
ILIAS Exercise Notification NotificationManager	$notification
ILIAS Exercise InternalDomainService	$domain
ILIAS Exercise InternalGUIService	$gui
ilObjUser	$user
ilCtrl	$ctrl
ilTabsGUI	$tabs_gui
ilLanguage	$lng
ilGlobalTemplateInterface	$tpl
ilObjExercise	$exercise
ilExSubmission	$submission
ilExAssignment	$assignment
MandatoryAssignmentsManager	$mandatory_manager
ContextServices	$tool_context
ilExAssignmentTypesGUI	$type_guis
int	$requested_ref_id
GUIRequest	$request

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

@ilCtrl_Calls ilExSubmissionTextGUI:

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

Constructor & Destructor Documentation

__construct()

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

Exceptions

ilExcUnknownAssignmentTypeException

Reimplemented from ilExSubmissionBaseGUI.

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

      {
        global $DIC;
 
        parent::__construct($a_exercise, $a_submission);
        $this->user = $DIC->user();
        $this->help = $DIC["ilHelp"];
        $this->sub_manager = $DIC->exercise()->internal()->domain()->submission(
            $a_submission->getAssignment()->getId()
        );
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilExSubmission\getAssignment(), ILIAS\Repository\help(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

autoSaveObject()

ilExSubmissionTextGUI::autoSaveObject

(

)

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

                                    : void
    {
        $ilCtrl = $this->ctrl;
 
        if (!$this->submission->canSubmit()) {
            return;
        }
 
        $form = $this->initAssignmentTextForm();
 
        // we are not using a purifier, so we have to set the valid RTE tags
        // :TODO:
        $rte = $form->getItemByPostVar("atxt");
        $rte->setRteTags(ilRTESettings::_getUsedHTMLTags("exc_ass"));
 
        if ($form->checkInput()) {
            $text = trim($form->getInput("atxt"));
 
            $returned_id = $this->submission->updateTextSubmission(
                // mob src to mob id
                ilRTE::_replaceMediaObjectImageSrc($text, 0)
            );
 
            // no empty text
            if ($returned_id) {
                // mob usage
                $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();
            }
        }
    }

References $text, ilObjMediaObject\_exists(), ilRTE\_getMediaObjects(), ilRTESettings\_getUsedHTMLTags(), ilObjMediaObject\_removeUsage(), ilRTE\_replaceMediaObjectImageSrc(), and ilObjMediaObject\_saveUsage().

Here is the call graph for this function:

editAssignmentTextObject()

ilExSubmissionTextGUI::editAssignmentTextObject

(

?ilPropertyFormGUI

$a_form = null

)

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

     : void {
        $ilCtrl = $this->ctrl;
 
        if (!$this->submission->canSubmit()) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("exercise_time_over"), true);
            $ilCtrl->redirect($this, "returnToParent");
        }
 
        $this->triggerAssignmentTool();
 
        $this->handleTabs();
 
        $ilHelp = $this->help;
        $ilHelp->setScreenIdComponent("exc");
        $ilHelp->setScreenId("text_submission");
 
        if ($a_form === null) {
            $a_form = $this->initAssignmentTextForm();
 
            $sub = $this->sub_manager->getSubmissionsOfUser($this->submission->getUserId())->current();
            if ($sub) {
                if (trim($sub->getText()) !== '' && trim($sub->getText()) !== '0') {
                    $text = $a_form->getItemByPostVar("atxt");
                    // mob id to mob src
                    $text->setValue(ilRTE::_replaceMediaObjectImageSrc($sub->getText(), 1));
                }
            }
        }
 
        $this->tpl->addJavaScript("assets/js/exc-auto-saver.js");
        $this->lng->toJS("exc_auto_saved_minutes_s");
        $this->lng->toJS("exc_auto_saved_minutes_p");
        $mess_tpl = new ilTemplate("tpl.exc_auto_save_mess.html", true, true, "components/ILIAS/Exercise");
        $mess_tpl->setVariable("MESS", $this->lng->txt("exc_auto_save_info"));
        $mess_tpl->setVariable("MESS_LAST_SAVE", $this->lng->txt("exc_auto_last_save"));
        $mbox = $this->gui->ui()->factory()->messageBox()->info($mess_tpl->get());
        $sec_tpl = new ilTemplate("tpl.exc_auto_save_section.html", true, true, "components/ILIAS/Exercise");
        $sec_tpl->setVariable("AUTO_SAVE_URL", $ilCtrl->getLinkTargetByClass(self::class, "autoSave"));
        $sec_tpl->setVariable("MBOX", $this->gui->ui()->renderer()->render($mbox));
        $sec_tpl->setVariable("FORM", $a_form->getHTML());
        $this->tpl->setContent($sec_tpl->get());
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

executeCommand()

ilExSubmissionTextGUI::executeCommand

(

)

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

                                    : void
    {
        $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;
        }
    }

References ilExSubmissionBaseGUI\$ctrl, ilCtrl\getNextClass(), and ilExAssignment\TYPE_TEXT.

Here is the call graph for this function:

getOverviewContent()

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

static

Reimplemented from ilExSubmissionBaseGUI.

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

     : void {
        global $DIC;
 
        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();
        $gui = $DIC->exercise()->internal()->gui();
 
        if ($a_submission->canSubmit()) {
            $link = $gui->link(
                $lng->txt("exc_text_assignment_edit"),
                $ilCtrl->getLinkTargetByClass(array(ilAssignmentPresentationGUI::class, "ilExSubmissionGUI", "ilExSubmissionTextGUI"), "editAssignmentText")
            )->primary();
        } else {
            $link = $gui->link(
                $lng->txt("exc_text_assignment_show"),
                $ilCtrl->getLinkTargetByClass(array(ilAssignmentPresentationGUI::class, "ilExSubmissionGUI", "ilExSubmissionTextGUI"), "showAssignmentText")
            )->emphasised();
        }
        $files_str = $link->render();
 
        $a_info->addProperty($lng->txt("exc_files_returned_text"), $files_str);
    }

References ilExSubmissionBaseGUI\$gui, ilExSubmissionBaseGUI\$lng, and ilLanguage\txt().

Here is the call graph for this function:

initAssignmentTextForm()

ilExSubmissionTextGUI::initAssignmentTextForm ( bool  $a_read_only = false )

protected

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

     : ilPropertyFormGUI {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $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(
                $this->mandatory_manager->isMandatoryForUser($this->submission->getAssignment()->getId(), $this->user->getId())
            );
            $text->setRows(15);
            $text->setMaxNumOfChars($this->assignment->getMaxCharLimit());
            $text->setMinNumOfChars($this->assignment->getMinCharLimit());
 
            if ($text->isCharLimited()) {
                $char_msg = "";
                if ($this->assignment->getMinCharLimit() !== 0) {
                    $char_msg .= $lng->txt("exc_min_char_limit") . ": " . $this->assignment->getMinCharLimit();
                }
                if ($this->assignment->getMaxCharLimit() !== 0) {
                    $char_msg .= " " . $lng->txt("exc_max_char_limit") . ": " . $this->assignment->getMaxCharLimit();
                }
                $text->setInfo($char_msg);
            }
 
            $form->addItem($text);
 
            if ((new ilRTESettings($this->lng, $this->user))->getRichTextEditor() === "tinymce") {
                $text->setUseRte(true);
                $text->setRteTagSet("mini");
            }
 
            $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;
    }

showAssignmentTextObject()

ilExSubmissionTextGUI::showAssignmentTextObject

(

)

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

                                              : void
    {
        if (!$this->submission->isTutor()) {
            $this->handleTabs();
        }
 
        $a_form = $this->initAssignmentTextForm(true);
 
        $sub = $this->sub_manager->getSubmissionsOfUser($this->submission->getUserId())->current();
        if ($sub) {
            if (trim($sub->getText()) !== '' && trim($sub->getText()) !== '0') {
                if ($sub->getLate() &&
                    !$this->submission->hasPeerReviewAccess()) {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt("exc_late_submission"));
                }
 
                $text = $a_form->getItemByPostVar("atxt");
                // mob id to mob src
                $val = $this->gui->getUIUtil()->formatTextInput($sub->getText());
                $val = $this->gui->html()->escapeCurly($val);
                $text->setValue($val);
            }
        }
        $this->tpl->setContent($a_form->getHTML());
    }

References $text, and ILIAS\Repository\lng().

Here is the call graph for this function:

updateAssignmentTextAndReturnObject()

ilExSubmissionTextGUI::updateAssignmentTextAndReturnObject

(

)

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

                                                         : void
    {
        $this->updateAssignmentTextObject(true);
    }

updateAssignmentTextObject()

ilExSubmissionTextGUI::updateAssignmentTextObject

(

bool

$a_return = false

)

Exceptions

ilExcUnknownAssignmentTypeException
ilExerciseException

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

     : void {
        $ilCtrl = $this->ctrl;
 
        if (!$this->submission->canSubmit()) {
            $this->tpl->setOnScreenMessage('failure', $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:
        $rte = $form->getItemByPostVar("atxt");
        $rte->setRteTags(ilRTESettings::_getUsedHTMLTags("exc_ass"));
 
        if ($form->checkInput()) {
            $text = trim($form->getInput("atxt"));
 
            $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
                $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();
            }
 
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("exc_text_saved"), true);
            if ($a_return) {
                $ilCtrl->redirect($this, "returnToParent");
            } else {
                $ilCtrl->redirect($this, "editAssignmentText");
            }
        }
 
        $form->setValuesByPost();
        $this->editAssignmentTextObject($form);
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

Field Documentation

$help

ilHelpGUI ilExSubmissionTextGUI::$help

protected

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

$sub_manager

ILIAS Exercise Submission SubmissionManager ilExSubmissionTextGUI::$sub_manager

protected

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

$user

ilObjUser ilExSubmissionTextGUI::$user

protected

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

---

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

• components/ILIAS/Exercise/Submission/class.ilExSubmissionTextGUI.php