ilExSubmissionObjectGUI Class Reference

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

Inheritance diagram for ilExSubmissionObjectGUI:

Collaboration diagram for ilExSubmissionObjectGUI:

Public Member Functions
	__construct (ilObjExercise $a_exercise, ilExSubmission $a_submission)
	executeCommand ()
	submitBlog (int $a_blog_id)
	Submit blog for assignment. More...
	submitPortfolio (int $a_portfolio_id)
	Submit portfolio for assignment. More...
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	initGUIForSubmit (int $a_ass_id, int $a_user_id=null)
Static Public Member Functions inherited from ilExSubmissionBaseGUI
static	getOverviewContent (ilInfoScreenGUI $a_info, ilExSubmission $a_submission)

Protected Member Functions
	renderResourceSelection (string $a_title, string $a_info, string $a_cmd, string $a_explorer_cmd, array $a_items=null)
	createBlogObject ()
	selectBlogObject ()
	saveBlogObject ()
	setSelectedBlogObject ()
	renderWorkspaceExplorer (string $a_cmd)
	selectPortfolioObject ()
	initPortfolioTemplateForm (array $a_templates)
	createPortfolioFromAssignmentObject ()
	createPortfolioTemplateObject (ilPropertyFormGUI $a_form=null)
	setSelectedPortfolioTemplateObject ()
	createPortfolioObject ()
	setSelectedPortfolioObject ()
	askUnlinkPortfolioObject ()
	unlinkPortfolioObject ()
	askUnlinkBlogObject ()
	unlinkBlogObject ()
	askDirectSubmissionObject ()
	directSubmitObject ()
Protected Member Functions inherited from ilExSubmissionBaseGUI
	handleTabs ()
	handleNewUpload (bool $a_no_notifications=false)
	handleRemovedUpload ()
	triggerAssignmentTool ()

Static Protected Member Functions
static	getOverviewContentBlog (ilInfoScreenGUI $a_info, ilExSubmission $a_submission)
static	getOverviewContentPortfolio (ilInfoScreenGUI $a_info, ilExSubmission $a_submission)

Protected Attributes
int	$user_id
	$selected_wsp_obj_id
Protected Attributes inherited from ilExSubmissionBaseGUI
ILIAS Exercise Notification NotificationManager	$notification
ILIAS Exercise InternalDomainService	$domain
ILIAS Exercise InternalGUIService	$gui
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

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

ilExSubmissionObjectGUI:

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

Constructor & Destructor Documentation

__construct()

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

Exceptions

ilExcUnknownAssignmentTypeException

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

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

      {
        global $DIC;

        $this->user_id = $DIC->user()->getId();

        parent::__construct($a_exercise, $a_submission);
        $this->selected_wsp_obj_id = $this->request->getSelectedWspObjId();
    }

Here is the call graph for this function:

Member Function Documentation

askDirectSubmissionObject()

ilExSubmissionObjectGUI::askDirectSubmissionObject ( )

protected

Definition at line 690 of file class.ilExSubmissionObjectGUI.php.

References ilExSubmissionBaseGUI\$tpl, $txt, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilExSubmissionBaseGUI\returnToParentObject(), ilGlobalTemplateInterface\setContent(), and ilGlobalTemplateInterface\setOnScreenMessage().

                                                  : void
    {
        $tpl = $this->tpl;

        if (!$this->submission->canSubmit()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("exercise_time_over"), true);
            $this->returnToParentObject();
        }

        $conf = new ilConfirmationGUI();

        if ($this->request->getBlogId() > 0) {
            $this->ctrl->setParameter($this, "blog_id", $this->request->getBlogId());
            $txt = $this->lng->txt("exc_direct_submit_blog");
        } else {
            $this->ctrl->setParameter($this, "prtf_id", $this->request->getPortfolioId());
            $txt = $this->lng->txt("exc_direct_submit_portfolio");
        }
        $conf->setFormAction($this->ctrl->getFormAction($this, "directSubmit"));

        $conf->setHeaderText($txt);
        $conf->setConfirm($this->lng->txt("exc_direct_submit"), "directSubmit");
        $conf->setCancel($this->lng->txt("exc_direct_no_submit"), "returnToParent");

        $tpl->setContent($conf->getHTML());
    }

Here is the call graph for this function:

askUnlinkBlogObject()

ilExSubmissionObjectGUI::askUnlinkBlogObject ( )

protected

Definition at line 657 of file class.ilExSubmissionObjectGUI.php.

References ilExSubmissionBaseGUI\$submission, ilExSubmissionBaseGUI\$tpl, ILIAS\Repository\ctrl(), ilUtil\getImagePath(), ilExSubmission\getSelectedObject(), ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), ILIAS\Repository\lng(), ilWorkspaceTree\lookupObjectId(), and ilGlobalTemplateInterface\setContent().

                                            : void
    {
        $tpl = $this->tpl;

        $conf = new ilConfirmationGUI();
        $conf->setFormAction($this->ctrl->getFormAction($this, "unlinkBlog"));
        $conf->setHeaderText($this->lng->txt("exc_sure_unlink_blog"));
        $conf->setConfirm($this->lng->txt("confirm"), "unlinkBlog");
        $conf->setCancel($this->lng->txt("cancel"), "returnToParent");

        $submission = $this->submission->getSelectedObject();
        $wstree = new ilWorkspaceTree($this->submission->getUserId());
        $object_id = $wstree->lookupObjectId((int) $submission?->getTitle());
        $port = new ilObjBlog($object_id, false);

        $conf->addItem("id[]", "", $port->getTitle(), ilUtil::getImagePath("standard/icon_blog.svg"));

        $tpl->setContent($conf->getHTML());
    }

Here is the call graph for this function:

askUnlinkPortfolioObject()

ilExSubmissionObjectGUI::askUnlinkPortfolioObject ( )

protected

Definition at line 622 of file class.ilExSubmissionObjectGUI.php.

References ilExSubmissionBaseGUI\$submission, ilExSubmissionBaseGUI\$tpl, ILIAS\Repository\ctrl(), ilUtil\getImagePath(), ilExSubmission\getSelectedObject(), ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), ILIAS\Repository\lng(), and ilGlobalTemplateInterface\setContent().

                                                 : void
    {
        $tpl = $this->tpl;

        $conf = new ilConfirmationGUI();
        $conf->setFormAction($this->ctrl->getFormAction($this, "unlinkPortfolio"));
        $conf->setHeaderText($this->lng->txt("exc_sure_unlink_portfolio", "sure_unlink_portfolio"));
        $conf->setConfirm($this->lng->txt("confirm"), "unlinkPortfolio");
        $conf->setCancel($this->lng->txt("cancel"), "returnToParent");

        $submission = $this->submission->getSelectedObject();
        $port = new ilObjPortfolio((int) $submission?->getTitle(), false);

        $conf->addItem("id[]", "", $port->getTitle(), ilUtil::getImagePath("standard/icon_prtf.svg"));

        $tpl->setContent($conf->getHTML());
    }

Here is the call graph for this function:

createBlogObject()

ilExSubmissionObjectGUI::createBlogObject ( )

protected

Definition at line 316 of file class.ilExSubmissionObjectGUI.php.

References ilExSubmissionBaseGUI\handleTabs(), and renderResourceSelection().

Referenced by saveBlogObject().

                                         : void
    {
        $this->handleTabs();

        $this->renderResourceSelection(
            "exc_create_blog",
            "exc_create_blog_select_info",
            "saveBlog",
            "createBlog"
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createPortfolioFromAssignmentObject()

ilExSubmissionObjectGUI::createPortfolioFromAssignmentObject ( )

protected

Definition at line 481 of file class.ilExSubmissionObjectGUI.php.

References ilExSubmissionBaseGUI\$ctrl, $DIC, ilObject\_lookupObjectId(), createPortfolioTemplateObject(), ilObjPortfolioTemplate\getAvailablePortfolioTemplates(), ilCtrl\redirectByClass(), and ilCtrl\setParameterByClass().

                                                            : void
    {
        global $DIC;

        $ctrl = $DIC->ctrl();

        $templates = ilObjPortfolioTemplate::getAvailablePortfolioTemplates();

        //template id is stored in the DB with the ref_id.
        $template_id = $this->assignment->getPortfolioTemplateId();
        //get the object id to compare with a list of template objects.
        $template_object_id = ilObject::_lookupObjectId($template_id);

        // select a template, if available
        if ($templates !== [] && $template_object_id == 0) {
            $this->createPortfolioTemplateObject();
            return;
        }

        $title = $this->exercise->getTitle() . " - " . $this->assignment->getTitle();
        $ctrl->setParameterByClass("ilObjPortfolioGUI", "exc_id", $this->exercise->getRefId());
        $ctrl->setParameterByClass("ilObjPortfolioGUI", "ass_id", $this->assignment->getId());
        $ctrl->setParameterByClass("ilObjPortfolioGUI", "pt", $title);

        if ($template_object_id > 0) {
            $ctrl->setParameterByClass("ilObjPortfolioGUI", "prtt", $template_object_id);
        }
        $ctrl->setParameterByClass("ilobjportfoliogui", "exc_back_ref_id", $this->requested_ref_id);
        $ctrl->redirectByClass(array("ildashboardgui", "ilPortfolioRepositoryGUI", "ilObjPortfolioGUI"), "createPortfolioFromAssignment");
    }

Here is the call graph for this function:

createPortfolioObject()

ilExSubmissionObjectGUI::createPortfolioObject ( )

protected

Exceptions

ilExcUnknownAssignmentTypeException
ilExerciseException

Definition at line 574 of file class.ilExSubmissionObjectGUI.php.

References ILIAS\Repository\ctrl(), ilExSubmissionBaseGUI\handleRemovedUpload(), ILIAS\Repository\lng(), and ilExSubmissionBaseGUI\returnToParentObject().

Referenced by setSelectedPortfolioTemplateObject().

                                              : void
    {
        if (!$this->submission->canSubmit()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("exercise_time_over"), true);
            $this->returnToParentObject();
        }

        $portfolio = new ilObjPortfolio();
        $portfolio->setTitle($this->exercise->getTitle() . " - " . $this->assignment->getTitle());
        $portfolio->create();

        $this->submission->deleteAllFiles();
        $this->handleRemovedUpload();

        $this->submission->addResourceObject($portfolio->getId());

        $this->tpl->setOnScreenMessage('success', $this->lng->txt("exc_portfolio_created"), true);
        $this->ctrl->setParameterByClass(ilObjPortfolioGUI::class, "prt_id", $portfolio->getId());
        $this->ctrl->redirectByClass(array("ildashboardgui", "ilPortfolioRepositoryGUI", "ilObjPortfolioGUI"), "view");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createPortfolioTemplateObject()

ilExSubmissionObjectGUI::createPortfolioTemplateObject ( ilPropertyFormGUI  $a_form = null )

protected

Definition at line 512 of file class.ilExSubmissionObjectGUI.php.

References ilObjPortfolioTemplate\getAvailablePortfolioTemplates(), initPortfolioTemplateForm(), ILIAS\Repository\lng(), and ilExSubmissionBaseGUI\returnToParentObject().

Referenced by createPortfolioFromAssignmentObject(), and setSelectedPortfolioTemplateObject().

     : void {
        if (!$this->submission->canSubmit()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("exercise_time_over"), true);
            $this->returnToParentObject();
        }

        $templates = ilObjPortfolioTemplate::getAvailablePortfolioTemplates();
        if ($templates === []) {
            $this->returnToParentObject();
        }

        if ($a_form === null) {
            $a_form = $this->initPortfolioTemplateForm($templates);
        }

        $this->tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

directSubmitObject()

ilExSubmissionObjectGUI::directSubmitObject ( )

protected

Exceptions

ilException
ilFileUtilsException

Definition at line 721 of file class.ilExSubmissionObjectGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilExSubmissionBaseGUI\returnToParentObject(), submitBlog(), and submitPortfolio().

                                           : void
    {
        if (!$this->submission->canSubmit()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("exercise_time_over"), true);
            $this->returnToParentObject();
        }

        $success = false;

        // submit current version of blog
        if ($this->request->getBlogId() > 0) {
            $success = $this->submitBlog($this->request->getBlogId());
            $this->ctrl->setParameter($this, "blog_id", "");
        }
        // submit current version of portfolio
        elseif ($this->request->getPortfolioId() > 0) {
            $success = $this->submitPortfolio($this->request->getPortfolioId());
            $this->ctrl->setParameter($this, "prtf_id", "");
        }

        if ($success) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("settings_saved"), true);
        } else {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("msg_failed"), true);
        }
        $this->ctrl->redirectByClass([ilExerciseHandlerGUI::class, ilObjExerciseGUI::class, ilAssignmentPresentationGUI::class, ilExSubmissionGUI::class, ilExSubmissionObjectGUI::class], "returnToParent");
    }

Here is the call graph for this function:

executeCommand()

ilExSubmissionObjectGUI::executeCommand

(

)

Definition at line 49 of file class.ilExSubmissionObjectGUI.php.

References ilExSubmissionBaseGUI\$ctrl, and ilExSubmissionBaseGUI\returnToParentObject().

                                    : void
    {
        $ilCtrl = $this->ctrl;

        if (!$this->submission->canView()) {
            $this->returnToParentObject();
        }

        $class = $ilCtrl->getNextClass($this);
        $cmd = $ilCtrl->getCmd();

        switch ($class) {
            default:
                $this->{$cmd . "Object"}();
                break;
        }
    }

Here is the call graph for this function:

getOverviewContent()

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

static

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

References ilExSubmission\getAssignment(), ilExAssignment\TYPE_BLOG, and ilExAssignment\TYPE_PORTFOLIO.

     : void {
        switch ($a_submission->getAssignment()->getType()) {
            case ilExAssignment::TYPE_BLOG:
                self::getOverviewContentBlog($a_info, $a_submission);
                break;

            case ilExAssignment::TYPE_PORTFOLIO:
                self::getOverviewContentPortfolio($a_info, $a_submission);
                break;
        }
    }

Here is the call graph for this function:

getOverviewContentBlog()

static ilExSubmissionObjectGUI::getOverviewContentBlog ( ilInfoScreenGUI  $a_info, ilExSubmission  $a_submission  )

staticprotected

Definition at line 82 of file class.ilExSubmissionObjectGUI.php.

References $DIC, ilExSubmissionBaseGUI\$gui, ilExSubmissionBaseGUI\$lng, ilInfoScreenGUI\addProperty(), ilExSubmission\canSubmit(), ilWorkspaceTree\createTreeForUser(), ilExSubmission\deleteResourceObject(), ilExSubmission\getSelectedObject(), ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), ilExSubmission\getUserId(), ilExSubmission\hasSubmitted(), ILIAS\Repository\int(), and ilLanguage\txt().

     : void {
        global $DIC;

        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();
        $gui = $DIC->exercise()->internal()->gui();

        $wsp_tree = new ilWorkspaceTree($a_submission->getUserId());

        // #12939
        if (!$wsp_tree->getRootId()) {
            $wsp_tree->createTreeForUser($a_submission->getUserId());
        }

        $files_str = "";
        $buttons_str = "";
        $valid_blog = false;
        $selected_blog = $a_submission->getSelectedObject();
        if ($selected_blog) {
            $blog_id = (int) $selected_blog?->getTitle();
            $node = $wsp_tree->getNodeData($blog_id);
            if ($node["title"]) {
                // #10116
                $ilCtrl->setParameterByClass("ilobjbloggui", "wsp_id", $blog_id);
                $blog_link = $ilCtrl->getLinkTargetByClass(array("ildashboardgui", "ilpersonalworkspacegui", "ilobjbloggui"), "");
                $ilCtrl->setParameterByClass("ilobjbloggui", "wsp_id", "");
                $files_str = '<a href="' . $blog_link . '">' .
                    $node["title"] . '</a>';
                $valid_blog = true;
            }
            // remove invalid resource if no upload yet (see download below)
            elseif (substr($selected_blog["filename"], -1) == "/") {
                // #16887
                $a_submission->deleteResourceObject();
            }
        }
        if ($a_submission->canSubmit()) {
            if (!$valid_blog) {
                $button = $gui->button(
                    $lng->txt("exc_create_blog"),
                    $ilCtrl->getLinkTargetByClass(array(ilAssignmentPresentationGUI::class, "ilExSubmissionGUI", "ilExSubmissionObjectGUI"), "createBlog")
                );
                $buttons_str .= $button->render();
            }
            // #10462
            $blogs = count($wsp_tree->getObjectsFromType("blog"));
            if ((!$valid_blog && $blogs)
                || ($valid_blog && $blogs > 1)) {
                $link = $gui->link(
                    $lng->txt("exc_select_blog" . ($valid_blog ? "_change" : "")),
                    $ilCtrl->getLinkTargetByClass(array(ilAssignmentPresentationGUI::class, "ilExSubmissionGUI", "ilExSubmissionObjectGUI"), "selectBlog")
                )->emphasised();
                $buttons_str .= " " . $link->render();
            }
        }

        // todo: move this to ks somehow
        if ($buttons_str != "") {
            $files_str .= "<p>" . $buttons_str . "</p>";
        }


        if ($files_str) {
            $a_info->addProperty($lng->txt("exc_blog_returned"), $files_str);
        }
        if ($a_submission->hasSubmitted()) {
            $ilCtrl->setParameterByClass("ilExSubmissionFileGUI", "delivered", $selected_blog["returned_id"]);
            $dl_link = $ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExSubmissionFileGUI"), "download");
            $ilCtrl->setParameterByClass("ilExSubmissionFileGUI", "delivered", "");

            $button = $gui->button(
                $lng->txt("download"),
                $dl_link
            );

            $a_info->addProperty($lng->txt("exc_files_returned"), $button->render());
        }
    }

Here is the call graph for this function:

getOverviewContentPortfolio()

static ilExSubmissionObjectGUI::getOverviewContentPortfolio ( ilInfoScreenGUI  $a_info, ilExSubmission  $a_submission  )

staticprotected

Definition at line 164 of file class.ilExSubmissionObjectGUI.php.

References $DIC, ilExSubmissionBaseGUI\$gui, ilExSubmissionBaseGUI\$lng, $ref_id, ilExSubmissionBaseGUI\$request, ilObject\_exists(), ilInfoScreenGUI\addProperty(), ilExSubmission\canSubmit(), ilExSubmission\deleteResourceObject(), ilObjPortfolio\getPortfoliosOfUser(), ilExSubmission\getSelectedObject(), ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), ilExSubmission\getUserId(), ilExSubmission\hasSubmitted(), ILIAS\Repository\int(), and ilLanguage\txt().

                                                                                                                : void
    {
        global $DIC;

        $back_ref_id = $DIC->http()->wrapper()->query()->retrieve(
            "ref_id",
            $DIC->refinery()->kindlyTo()->int()
        ) ?? 0;

        $request = $DIC->exercise()->internal()->gui()->request();
        $gui = $DIC->exercise()->internal()->gui();


        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();

        $files_str = "";
        $buttons_str = "";
        $valid_prtf = false;
        $selected_prtf = $a_submission->getSelectedObject();
        if ($selected_prtf) {
            $portfolio_id = (int) $selected_prtf?->getTitle();

            // #11746
            if (ilObject::_exists($portfolio_id, false, "prtf")) {
                $portfolio = new ilObjPortfolio($portfolio_id, false);
                if ($portfolio->getTitle()) {
                    // #10116 / #12791
                    $ilCtrl->setParameterByClass("ilobjportfoliogui", "prt_id", $portfolio_id);

                    $ref_id = $request->getRefId();
                    $ilCtrl->setParameterByClass("ilobjportfoliogui", "ref_id", $ref_id);
                    $ilCtrl->setParameterByClass("ilobjportfoliogui", "exc_back_ref_id", $back_ref_id);

                    $prtf_link = $ilCtrl->getLinkTargetByClass(array("ildashboardgui", "ilportfoliorepositorygui", "ilobjportfoliogui"), "view");
                    $ilCtrl->setParameterByClass("ilobjportfoliogui", "prt_id", "");
                    $ilCtrl->setParameterByClass("ilobjportfoliogui", "ref_id", "");


                    $files_str = '<a href="' . $prtf_link .
                        '">' . $portfolio->getTitle() . '</a>';
                    $valid_prtf = true;
                }
            }
            // remove invalid resource if no upload yet (see download below)
            elseif (substr($selected_prtf["filename"], -1) == "/") {
                // #16887
                $a_submission->deleteResourceObject();
            }
        }
        if ($a_submission->canSubmit()) {
            if (!$valid_prtf) {
                $button = $gui->button(
                    $lng->txt("exc_create_portfolio"),
                    $ilCtrl->getLinkTargetByClass(array(ilAssignmentPresentationGUI::class, "ilExSubmissionGUI", "ilExSubmissionObjectGUI"), "createPortfolioFromAssignment")
                );

                $buttons_str .= $button->render();
            }
            // #10462
            //selectPortfolio ( remove it? )
            $prtfs = count(ilObjPortfolio::getPortfoliosOfUser($a_submission->getUserId()));
            if ((!$valid_prtf && $prtfs)
                || ($valid_prtf && $prtfs > 1)) {
                $link = $gui->link(
                    $lng->txt("exc_select_portfolio" . ($valid_prtf ? "_change" : "")),
                    $ilCtrl->getLinkTargetByClass(array(ilAssignmentPresentationGUI::class, "ilExSubmissionGUI", "ilExSubmissionObjectGUI"), "selectPortfolio")
                )->emphasised();

                $buttons_str .= " " . $link->render();
            }
            if ($valid_prtf) {
                $link = $gui->link(
                    $lng->txt("exc_select_portfolio_unlink"),
                    $ilCtrl->getLinkTargetByClass(array(ilAssignmentPresentationGUI::class, "ilExSubmissionGUI", "ilExSubmissionObjectGUI"), "askUnlinkPortfolio")
                )->emphasised();
                $buttons_str .= " " . $link->render();
            }
        }
        // todo: move this to ks somehow
        if ($buttons_str != "") {
            $files_str .= "<p>" . $buttons_str . "</p>";
        }
        if ($files_str) {
            $a_info->addProperty($lng->txt("exc_portfolio_returned"), $files_str);
        }
        if ($a_submission->hasSubmitted()) {
            $ilCtrl->setParameterByClass("ilExSubmissionFileGUI", "delivered", $selected_prtf["returned_id"]);
            $dl_link = $ilCtrl->getLinkTargetByClass(array(ilAssignmentPresentationGUI::class, "ilExSubmissionGUI", "ilExSubmissionFileGUI"), "download");
            $ilCtrl->setParameterByClass("ilExSubmissionFileGUI", "delivered", "");

            $button = $gui->button(
                $lng->txt("download"),
                $dl_link
            );

            $a_info->addProperty($lng->txt("exc_files_returned"), $button->render());
        }
    }

Here is the call graph for this function:

initGUIForSubmit()

static ilExSubmissionObjectGUI::initGUIForSubmit ( int  $a_ass_id, int  $a_user_id = null  )

static

Exceptions

ilExcUnknownAssignmentTypeException

Definition at line 859 of file class.ilExSubmissionObjectGUI.php.

References $DIC, and ilObject\_getAllReferences().

Referenced by ilBlogExerciseGUI\finalize(), and ilPortfolioExerciseGUI\finalize().

     : ilExSubmissionObjectGUI {
        global $DIC;

        $ilUser = $DIC->user();

        if (!$a_user_id) {
            $a_user_id = $ilUser->getId();
        }

        $ass = new ilExAssignment($a_ass_id);
        $sub = new ilExSubmission($ass, $a_user_id);
        $exc_id = $ass->getExerciseId();

        // #11173 - ref_id is needed for notifications
        $ref_ids = ilObject::_getAllReferences($exc_id);
        $exc_ref_id = current($ref_ids);
        $exc = new ilObjExercise($exc_ref_id, true);

        return new self($exc, $sub);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initPortfolioTemplateForm()

ilExSubmissionObjectGUI::initPortfolioTemplateForm ( array  $a_templates )

protected

Definition at line 459 of file class.ilExSubmissionObjectGUI.php.

References $id, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setRequired().

Referenced by createPortfolioTemplateObject(), and setSelectedPortfolioTemplateObject().

     : ilPropertyFormGUI {
        $form = new ilPropertyFormGUI();
        $form->setTitle($this->lng->txt("exc_create_portfolio") . ": " . $this->assignment->getTitle());
        $form->setFormAction($this->ctrl->getFormAction($this, "setSelectedPortfolioTemplate"));

        $prtt = new ilRadioGroupInputGUI($this->lng->txt("obj_prtt"), "prtt");
        $prtt->setRequired(true);
        $prtt->addOption(new ilRadioOption($this->lng->txt("exc_create_portfolio_no_template"), -1));
        foreach ($a_templates as $id => $title) {
            $prtt->addOption(new ilRadioOption('"' . $title . '"', $id));
        }
        $prtt->setValue(-1);
        $form->addItem($prtt);

        $form->addCommandButton("setSelectedPortfolioTemplate", $this->lng->txt("save"));
        $form->addCommandButton("returnToParent", $this->lng->txt("cancel"));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderResourceSelection()

ilExSubmissionObjectGUI::renderResourceSelection ( string  $a_title, string  $a_info, string  $a_cmd, string  $a_explorer_cmd, array  $a_items = null  )

protected

Definition at line 264 of file class.ilExSubmissionObjectGUI.php.

References Vendor\Package\$f, $r, ilExSubmissionBaseGUI\$tpl, ILIAS\Repository\ctrl(), ilGlobalTemplateInterface\get(), ILIAS\Repository\lng(), ilGlobalTemplateInterface\parseCurrentBlock(), renderWorkspaceExplorer(), ilExSubmissionBaseGUI\returnToParentObject(), ilGlobalTemplateInterface\setCurrentBlock(), and ilGlobalTemplateInterface\setVariable().

Referenced by createBlogObject(), selectBlogObject(), and selectPortfolioObject().

     : void {
        if (!$this->submission->canSubmit()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("exercise_time_over"), true);
            $this->returnToParentObject();
        }

        $html = "";
        $tpl = new ilTemplate("tpl.exc_select_resource.html", true, true, "components/ILIAS/Exercise");

        if (is_array($a_items)) {
            $tpl->setCurrentBlock("item");
            foreach ($a_items as $item_id => $item_title) {
                $tpl->setVariable("ITEM_ID", $item_id);
                $tpl->setVariable("ITEM_TITLE", $item_title);
                $tpl->parseCurrentBlock();
            }
            $tpl->setVariable("FORM_ACTION", $this->ctrl->getFormAction($this));
            $tpl->setVariable("TXT_SUBMIT", $this->lng->txt("save"));
            $tpl->setVariable("TXT_CANCEL", $this->lng->txt("cancel"));
            $tpl->setVariable("CMD_SUBMIT", $a_cmd);
            $tpl->setVariable("CMD_CANCEL", "returnToParent");
            $html = $tpl->get();
        } elseif ($a_explorer_cmd) {
            $html = $this->renderWorkspaceExplorer($a_explorer_cmd);
        }


        $this->tpl->setOnScreenMessage('info', $this->lng->txt($a_info));

        $title = $this->lng->txt($a_title) . ": " . $this->assignment->getTitle();

        $f = $this->gui->ui()->factory();
        $r = $this->gui->ui()->renderer();
        $p = $f->panel()->standard(
            $title,
            $f->legacy($html)
        );

        $this->tpl->setContent($r->render($p));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderWorkspaceExplorer()

ilExSubmissionObjectGUI::renderWorkspaceExplorer ( string  $a_cmd )

protected

Definition at line 412 of file class.ilExSubmissionObjectGUI.php.

References exit, and ilTreeExplorerGUI\setTypeWhiteList().

Referenced by renderResourceSelection().

     : string {
        $exp2 = null;
        switch ($a_cmd) {
            case "selectBlog":
                $exp2 = new ilWorkspaceExplorerGUI($this->submission->getUserId(), $this, $a_cmd, $this, "setSelectedBlog");
                $exp2->setTypeWhiteList(array("blog", "wsrt", "wfld"));
                $exp2->setSelectableTypes(array("blog"));
                break;

            case "createBlog":
                $exp2 = new ilWorkspaceExplorerGUI($this->submission->getUserId(), $this, $a_cmd, $this, "saveBlog");
                $exp2->setTypeWhiteList(array("wsrt", "wfld"));
                $exp2->setSelectableTypes(array("wsrt", "wfld"));
                break;
        }
        if (!$exp2->handleCommand()) {
            return $exp2->getHTML();
        }
        exit;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveBlogObject()

ilExSubmissionObjectGUI::saveBlogObject ( )

protected

Exceptions

ilExcUnknownAssignmentTypeException
ilExerciseException

Definition at line 344 of file class.ilExSubmissionObjectGUI.php.

References $selected_wsp_obj_id, createBlogObject(), ILIAS\Repository\ctrl(), ilExSubmissionBaseGUI\handleRemovedUpload(), ilWorkspaceTree\insertObject(), ILIAS\Repository\lng(), and ilExSubmissionBaseGUI\returnToParentObject().

                                       : void
    {
        if (!$this->submission->canSubmit()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("exercise_time_over"), true);
            $this->returnToParentObject();
        }

        if ($this->selected_wsp_obj_id == 0) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("select_one"));
            $this->createBlogObject();
            return;
        }

        $parent_node = $this->selected_wsp_obj_id;

        $blog = new ilObjBlog();
        $blog->setTitle($this->exercise->getTitle() . " - " . $this->assignment->getTitle());
        $blog->create();

        $tree = new ilWorkspaceTree($this->submission->getUserId()); // #15993

        $node_id = $tree->insertObject($parent_node, $blog->getId());

        $access_handler = new ilWorkspaceAccessHandler($tree);
        $access_handler->setPermissions($parent_node, $node_id);

        $this->submission->deleteAllFiles();
        $this->handleRemovedUpload();

        $this->submission->addResourceObject($node_id);

        $this->tpl->setOnScreenMessage('success', $this->lng->txt("exc_blog_created"), true);
        $this->ctrl->setParameterByClass(ilObjBlogGUI::class, "wsp_id", $node_id);
        $this->ctrl->redirectByClass(
            [ilDashboardGUI::class, ilPersonalWorkspaceGUI::class, ilObjBlogGUI::class],
            ""
        );
    }

Here is the call graph for this function:

selectBlogObject()

ilExSubmissionObjectGUI::selectBlogObject ( )

protected

Definition at line 328 of file class.ilExSubmissionObjectGUI.php.

References ilExSubmissionBaseGUI\handleTabs(), and renderResourceSelection().

Referenced by setSelectedBlogObject().

                                         : void
    {
        $this->handleTabs();

        $this->renderResourceSelection(
            "exc_select_blog",
            "exc_select_blog_info",
            "setSelectedBlog",
            "selectBlog"
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

selectPortfolioObject()

ilExSubmissionObjectGUI::selectPortfolioObject ( )

protected

Definition at line 440 of file class.ilExSubmissionObjectGUI.php.

References ilObjPortfolio\getPortfoliosOfUser(), ilExSubmissionBaseGUI\handleTabs(), and renderResourceSelection().

Referenced by setSelectedPortfolioObject().

                                              : void
    {
        $this->handleTabs();

        $items = array();
        $portfolios = ilObjPortfolio::getPortfoliosOfUser($this->submission->getUserId());
        foreach ($portfolios as $portfolio) {
            $items[$portfolio["id"]] = $portfolio["title"];
        }

        $this->renderResourceSelection(
            "exc_select_portfolio",
            "exc_select_portfolio_info",
            "setSelectedPortfolio",
            "",
            $items
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setSelectedBlogObject()

ilExSubmissionObjectGUI::setSelectedBlogObject ( )

protected

Exceptions

ilExcUnknownAssignmentTypeException
ilExerciseException

Definition at line 387 of file class.ilExSubmissionObjectGUI.php.

References ILIAS\Repository\ctrl(), ilTree\getNodeData(), ilExSubmissionBaseGUI\handleRemovedUpload(), ILIAS\Repository\lng(), ilExSubmissionBaseGUI\returnToParentObject(), and selectBlogObject().

                                              : void
    {
        if (!$this->submission->canSubmit()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("exercise_time_over"), true);
            $this->returnToParentObject();
        }

        if ($this->selected_wsp_obj_id > 0) {
            $tree = new ilWorkspaceTree($this->submission->getUserId());
            $node = $tree->getNodeData($this->selected_wsp_obj_id);
            if ($node && $node["type"] == "blog") {
                $this->submission->deleteAllFiles();
                $this->handleRemovedUpload();

                $this->submission->addResourceObject($node["wsp_id"]);

                $this->tpl->setOnScreenMessage('success', $this->lng->txt("exc_blog_selected"), true);
                $this->ctrl->setParameter($this, "blog_id", $node["wsp_id"]);
                $this->ctrl->redirect($this, "askDirectSubmission");
            }
        }

        $this->selectBlogObject();
    }

Here is the call graph for this function:

setSelectedPortfolioObject()

ilExSubmissionObjectGUI::setSelectedPortfolioObject ( )

protected

Exceptions

ilExcUnknownAssignmentTypeException
ilExerciseException

Definition at line 599 of file class.ilExSubmissionObjectGUI.php.

References ILIAS\Repository\ctrl(), ilExSubmissionBaseGUI\handleRemovedUpload(), ILIAS\Repository\lng(), ilExSubmissionBaseGUI\returnToParentObject(), and selectPortfolioObject().

                                                   : void
    {
        if (!$this->submission->canSubmit()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("exercise_time_over"), true);
            $this->returnToParentObject();
        }

        $prtf_id = $this->request->getResourceObjectId();
        if ($prtf_id > 0) {
            $this->submission->deleteAllFiles();
            $this->handleRemovedUpload();

            $this->submission->addResourceObject($prtf_id);

            $this->tpl->setOnScreenMessage('success', $this->lng->txt("exc_portfolio_selected"), true);
            $this->ctrl->setParameter($this, "prtf_id", $prtf_id);
            $this->ctrl->redirect($this, "askDirectSubmission");
        }

        $this->tpl->setOnScreenMessage('failure', $this->lng->txt("select_one"));
        $this->selectPortfolioObject();
    }

Here is the call graph for this function:

setSelectedPortfolioTemplateObject()

ilExSubmissionObjectGUI::setSelectedPortfolioTemplateObject ( )

protected

Exceptions

ilExcUnknownAssignmentTypeException
ilExerciseException

Definition at line 536 of file class.ilExSubmissionObjectGUI.php.

References createPortfolioObject(), createPortfolioTemplateObject(), ILIAS\Repository\ctrl(), ilObjPortfolioTemplate\getAvailablePortfolioTemplates(), initPortfolioTemplateForm(), ILIAS\Repository\lng(), and ilExSubmissionBaseGUI\returnToParentObject().

                                                           : void
    {
        if (!$this->submission->canSubmit()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("exercise_time_over"), true);
            $this->returnToParentObject();
        }

        $templates = ilObjPortfolioTemplate::getAvailablePortfolioTemplates();
        if ($templates === []) {
            $this->ctrl->redirect($this, "returnToParent");
        }

        $form = $this->initPortfolioTemplateForm($templates);
        if ($form->checkInput()) {
            $prtt = $form->getInput("prtt");
            if ($prtt > 0 && array_key_exists($prtt, $templates)) {
                $title = $this->exercise->getTitle() . " - " . $this->assignment->getTitle();
                $this->ctrl->setParameterByClass("ilObjPortfolioGUI", "exc_id", $this->exercise->getRefId());
                $this->ctrl->setParameterByClass("ilObjPortfolioGUI", "ass_id", $this->assignment->getId());
                $this->ctrl->setParameterByClass("ilObjPortfolioGUI", "pt", $title);
                $this->ctrl->setParameterByClass("ilObjPortfolioGUI", "prtt", $prtt);
                $this->ctrl->setParameterByClass("ilobjportfoliogui", "exc_back_ref_id", $this->requested_ref_id);
                $this->ctrl->redirectByClass(array("ildashboardgui", "ilPortfolioRepositoryGUI", "ilObjPortfolioGUI"), "createPortfolioFromTemplate");
            } else {
                // do not use template
                $this->createPortfolioObject();
                return;
            }
        }

        $form->setValuesByPost();
        $this->createPortfolioTemplateObject($form);
    }

Here is the call graph for this function:

submitBlog()

ilExSubmissionObjectGUI::submitBlog

(

int

$a_blog_id

)

Submit blog for assignment.

Exceptions

ilFileUtilsException
ilException

Definition at line 754 of file class.ilExSubmissionObjectGUI.php.

References ilExSubmissionBaseGUI\handleNewUpload(), and ilObject2GUI\WORKSPACE_NODE_ID.

Referenced by directSubmitObject().

     : bool {
        if (!$this->submission->canSubmit()) {
            return false;
        }

        $subm = $this->domain->submission($this->submission->getAssignment()->getId());

        $blog_id = $a_blog_id;

        $blog_gui = new ilObjBlogGUI($blog_id, ilObject2GUI::WORKSPACE_NODE_ID);
        if ($blog_gui->getObject()) {
            $export = $blog_gui->buildExportFile();
            $file = $export->getFilePath();
            $size = filesize($file);
            if ($size) {
                $this->submission->deleteAllFiles();

                $subm->addLocalFile(
                    $this->user_id,
                    $file,
                    $blog_id . ".zip"
                );
                $export->delete();

                // print version
                $export = $blog_gui->buildExportFile(false, true);
                $file = $export->getFilePath();
                $size = filesize($file);
                if ($size) {
                    $subm->addLocalFile(
                        $this->user_id,
                        $file,
                        $blog_id . "print.zip"
                    );
                    $export->delete();
                }

                $this->handleNewUpload();
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

submitPortfolio()

ilExSubmissionObjectGUI::submitPortfolio

(

int

$a_portfolio_id

)

Submit portfolio for assignment.

Exceptions

ilFileUtilsException

Definition at line 804 of file class.ilExSubmissionObjectGUI.php.

References ilExSubmissionBaseGUI\handleNewUpload().

Referenced by directSubmitObject().

     : bool {
        if (!$this->submission->canSubmit()) {
            return false;
        }

        $prtf_id = $a_portfolio_id;
        $subm = $this->domain->submission($this->submission->getAssignment()->getId());

        $prtf = new ilObjPortfolio($prtf_id, false);
        if ($prtf->getTitle()) {
            $port_gui = new ilObjPortfolioGUI($prtf_id);
            $port_export = new PortfolioHtmlExport($port_gui);
            $port_export->exportHtml();

            $file = $port_export->getFilePath();

            $size = filesize($file);
            if ($size) {
                $this->submission->deleteAllFiles();

                $subm->addLocalFile(
                    $this->user_id,
                    $file,
                    $prtf_id . ".zip"
                );
                $port_export->delete();

                // print version
                $port_export = new PortfolioHtmlExport($port_gui);
                $port_export->setPrintVersion(true);
                $port_export->exportHtml();
                $file = $port_export->getFilePath();
                $size = filesize($file);

                if ($size) {
                    $subm->addLocalFile(
                        $this->user_id,
                        $file,
                        $prtf_id . "print.zip"
                    );
                    $file = $port_export->delete();
                }

                $this->handleNewUpload();
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

unlinkBlogObject()

ilExSubmissionObjectGUI::unlinkBlogObject ( )

protected

Definition at line 677 of file class.ilExSubmissionObjectGUI.php.

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

                                         : void
    {
        $this->submission->deleteResourceObject();

        $this->tpl->setOnScreenMessage('success', $this->lng->txt("exc_blog_unlinked_from_assignment"), true);

        $this->ctrl->redirect($this, "returnToParent");
    }

Here is the call graph for this function:

unlinkPortfolioObject()

ilExSubmissionObjectGUI::unlinkPortfolioObject ( )

protected

Definition at line 640 of file class.ilExSubmissionObjectGUI.php.

References $DIC, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

                                              : void
    {
        global $DIC;

        $user = $DIC->user();

        //$portfolio = $this->submission->getSelectedObject();
        //$port_id = $portfolio["returned_id"];

        //$ilsub = new ilExSubmission($this->assignment, $user->getId());
        $this->submission->deleteResourceObject();

        $this->tpl->setOnScreenMessage('success', $this->lng->txt("exc_portfolio_unlinked_from_assignment"), true);

        $this->ctrl->redirect($this, "returnToParent");
    }

Here is the call graph for this function:

Field Documentation

$selected_wsp_obj_id

ilExSubmissionObjectGUI::$selected_wsp_obj_id

protected

Definition at line 32 of file class.ilExSubmissionObjectGUI.php.

Referenced by saveBlogObject().

$user_id

int ilExSubmissionObjectGUI::$user_id

protected

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

---

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

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