Collaboration diagram for ilPortfolioExerciseGUI:

Public Member Functions
	__construct (int $a_user_id, int $a_obj_id)

	executeCommand ()

	downloadExcAssFile ()

	downloadExcSubFile ()

	getSubmitButton (int $ass_id)
	Get submit link. More...

	getDownloadSubmissionButton (int $ass_id)

	getActionButtons ()
	Get action buttons. More...

Static Public Member Functions
static	checkExercise (int $a_user_id, int $a_obj_id, bool $a_add_submit=false, bool $as_array=false)

Protected Member Functions
	finalize ()
	Finalize and submit portfolio to exercise. More...

Static Protected Member Functions
static	getExerciseInfo (int $a_user_id, int $a_assignment_id, bool $a_add_submit=false, bool $as_array=false)

Protected Attributes
ILIAS Exercise InternalDomainService	$exc_domain

StandardGUIRequest	$port_request

ilCtrl	$ctrl

ilLanguage	$lng

int	$user_id

int	$obj_id

int	$ass_id

string	$file

ilPortfolioExercise	$pe

ILIAS DI UIServices	$ui

Private Attributes
ilGlobalTemplateInterface	$main_tpl

Detailed Description

Class ilPortfolioExerciseGUI.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilPortfolioExerciseGUI::__construct	(	int	$a_user_id,
		int	$a_obj_id
	)

Definition at line 41 of file class.ilPortfolioExerciseGUI.php.

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

       {
         global $DIC;
         $this->main_tpl = $DIC->ui()->mainTemplate();
 
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->user_id = $a_user_id;
         $this->obj_id = $a_obj_id;
 
         $this->port_request = $DIC->portfolio()
             ->internal()
             ->gui()
             ->standardRequest();
 
         $this->ass_id = $this->port_request->getExcAssId();
         $this->file = $this->port_request->getExcFile();
         $this->ui = $DIC->ui();
         $this->exc_domain = $DIC->exercise()->internal()->domain();
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkExercise()

static ilPortfolioExerciseGUI::checkExercise	(	int	$a_user_id,
		int	$a_obj_id,
		bool	$a_add_submit = `false`,
		bool	$as_array = `false`
	)

static

Todo:: get rid of mixed return type

Returns: array|string|void

Definition at line 87 of file class.ilPortfolioExerciseGUI.php.

References $exercise, and ilPortfolioExercise\getAssignmentsOfPortfolio().

Referenced by ilPortfolioRepositoryGUI\getPortfolioList().

       {
         $pe = new ilPortfolioExercise($a_user_id, $a_obj_id);
 
         $info = [];
         foreach ($pe->getAssignmentsOfPortfolio() as $exercise) {
             $part = self::getExerciseInfo($a_user_id, $exercise["ass_id"], $a_add_submit, $as_array);
             if ($part) {
                 $info[] = $part;
             }
         }
         if (count($info) && !$as_array) {
             return implode("<br />", $info);
         }
 
         if ($as_array) {
             return $info;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ downloadExcAssFile()

ilPortfolioExerciseGUI::downloadExcAssFile ( )

Definition at line 248 of file class.ilPortfolioExerciseGUI.php.

References ilFileDelivery\deliverFileLegacy().

                                         : void
     {
         if ($this->file) {
             $ass = new ilExAssignment($this->ass_id);
             $ass_files = $ass->getFiles();
             if (count($ass_files) > 0) {
                 foreach ($ass_files as $file) {
                     if ($file["name"] == $this->file) {
                         ilFileDelivery::deliverFileLegacy($file["fullpath"], $file["name"]);
                     }
                 }
             }
         }
     }

Here is the call graph for this function:

◆ downloadExcSubFile()

ilPortfolioExerciseGUI::downloadExcSubFile ( )

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

References ilObjUser\_lookupName(), and ilObject\_lookupTitle().

                                         : void
     {
         $ass = new ilExAssignment($this->ass_id);
         $sub_manager = $this->exc_domain->submission($this->ass_id);
         $sub = $sub_manager->getSubmissionsOfUser($this->user_id)->current();
         if ($sub) {
             $user_data = ilObjUser::_lookupName($this->user_id);
             $title = ilObject::_lookupTitle($ass->getExerciseId()) . " - " .
                 $ass->getTitle() . " - " .
                 $user_data["firstname"] . " " .
                 $user_data["lastname"] . " (" .
                 $user_data["login"] . ").zip";
 
             $sub_manager->deliverFile(
                 $this->user_id,
                 $sub->getRid(),
                 $title
             );
         }
     }

Here is the call graph for this function:

◆ executeCommand()

ilPortfolioExerciseGUI::executeCommand ( )

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

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

                                     : void
     {
         $ilCtrl = $this->ctrl;
 
         if (!$this->ass_id ||
             !$this->user_id) {
             $this->ctrl->returnToParent($this);
         }
 
         $next_class = $ilCtrl->getNextClass($this);
         $cmd = $ilCtrl->getCmd();
 
         switch ($next_class) {
             default:
                 $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ finalize()

ilPortfolioExerciseGUI::finalize ( )

protected

Finalize and submit portfolio to exercise.

Definition at line 287 of file class.ilPortfolioExerciseGUI.php.

References $ctrl, $lng, ilExSubmissionObjectGUI\initGUIForSubmit(), and ilLanguage\txt().

                                  : void
     {
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
 
         $exc_gui = ilExSubmissionObjectGUI::initGUIForSubmit($this->ass_id);
         $exc_gui->submitPortfolio($this->obj_id);
 
         $this->main_tpl->setOnScreenMessage('success', $lng->txt("prtf_finalized"), true);
         $ilCtrl->returnToParent($this);
     }

Here is the call graph for this function:

◆ getActionButtons()

ilPortfolioExerciseGUI::getActionButtons ( )

Get action buttons.

Definition at line 349 of file class.ilPortfolioExerciseGUI.php.

References $ass_id, $exercise, ilPortfolioPage\getAllPortfolioPages(), ilPortfolioExercise\getAssignmentsOfPortfolio(), getDownloadSubmissionButton(), and getSubmitButton().

                                       : array
     {
         $pe = new ilPortfolioExercise($this->user_id, $this->obj_id);
 
         $buttons = [];
         $pages = ilPortfolioPage::getAllPortfolioPages($this->obj_id);
         foreach ($pe->getAssignmentsOfPortfolio() as $exercise) {
             $ass_id = $exercise["ass_id"];
             $buttons[$ass_id] = [];
             if (count($pages) > 0) {
                 $submit_button = $this->getSubmitButton($ass_id);
                 if ($submit_button) {
                     $buttons[$ass_id][] = $submit_button;
                 }
             }
             $download_button = $this->getDownloadSubmissionButton($ass_id);
             if ($download_button) {
                 $buttons[$ass_id][] = $download_button;
             }
         }
 
         return $buttons;
     }

Here is the call graph for this function:

◆ getDownloadSubmissionButton()

ilPortfolioExerciseGUI::getDownloadSubmissionButton ( int $ass_id )

Definition at line 322 of file class.ilPortfolioExerciseGUI.php.

References $ctrl, $lng, $ui, null, and ilLanguage\txt().

Referenced by getActionButtons().

      : ?\ILIAS\UI\Component\Button\Standard {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
         $ui = $this->ui;
 
         // submitted files
         $submission = new ilExSubmission(new ilExAssignment($ass_id), $this->user_id);
         if ($submission->hasSubmitted()) {
             // #16888
             $submitted = $submission->getSelectedObject();
             if ($submitted?->getTimestamp() != "") {
                 $ilCtrl->setParameterByClass("ilportfolioexercisegui", "ass", $ass_id);
                 $dl_link = $ilCtrl->getLinkTargetByClass("ilportfolioexercisegui", "downloadExcSubFile");
                 $ilCtrl->setParameterByClass("ilportfolioexercisegui", "ass", "");
                 $button = $ui->factory()->button()->standard($lng->txt("prtf_download_submission"), $dl_link);
                 return $button;
             }
         }
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExerciseInfo()

static ilPortfolioExerciseGUI::getExerciseInfo	(	int	$a_user_id,
		int	$a_assignment_id,
		bool	$a_add_submit = `false`,
		bool	$as_array = `false`
	)

staticprotected

Deprecated:

Returns: string|array

Exceptions

ilCtrlException
ilDateTimeException
ilExcUnknownAssignmentTypeException

Definition at line 118 of file class.ilPortfolioExerciseGUI.php.

References $DIC, ilObject\_getAllReferences(), ilLink\_getStaticLink(), ilObject\_lookupTitle(), ilDatePresentation\formatDate(), IL_CAL_DATETIME, ilDatePresentation\setUseRelativeDates(), ilLanguage\txt(), and ilDatePresentation\useRelativeDates().

       {
         global $DIC;
 
         $ui = $DIC->ui();
 
         $links = [];
         $buttons = [];
         $elements = [];
 
         $lng = $DIC->language();
         $ilCtrl = $DIC->ctrl();
         $rel = false;
 
         $ass = new ilExAssignment($a_assignment_id);
         $exercise_id = $ass->getExerciseId();
         if (!$exercise_id) {
             return "";
         }
 
         // is the assignment still open?
         $times_up = $ass->afterDeadlineStrict();
 
         // exercise goto
         $ref_ids = ilObject::_getAllReferences($exercise_id);
         $exc_ref_id = array_shift($ref_ids);
         $exc_link = ilLink::_getStaticLink($exc_ref_id, "exc");
 
         $info_arr["ass_title"] = $ass->getTitle();
         $text = sprintf(
             $lng->txt("prtf_exercise_info"),
             $ass->getTitle(),
             ilObject::_lookupTitle($exercise_id)
         );
         $links[] = $ui->factory()->link()->standard(ilObject::_lookupTitle($exercise_id), $exc_link);
         $info_arr["exc_title"] = ilObject::_lookupTitle($exercise_id);
 
         // submit button
         if ($a_add_submit && !$times_up && !$as_array) {
             $ilCtrl->setParameterByClass("ilportfolioexercisegui", "ass", $a_assignment_id);
             $submit_link = $ilCtrl->getLinkTargetByClass("ilportfolioexercisegui", "finalize");
             $ilCtrl->setParameterByClass("ilportfolioexercisegui", "ass", "");
 
             $buttons[] = $ui->factory()->button()->primary($lng->txt("prtf_finalize_portfolio"), $submit_link);
         }
 
         // submitted files
         $submission = new ilExSubmission($ass, $a_user_id);
         $info_arr["submitted"] = false;
         if ($submission->hasSubmitted()) {
             // #16888
             $submitted = $submission->getSelectedObject();
 
             if (!$as_array) {
                 $ilCtrl->setParameterByClass("ilportfolioexercisegui", "ass", $a_assignment_id);
                 $dl_link = $ilCtrl->getLinkTargetByClass("ilportfolioexercisegui", "downloadExcSubFile");
                 $ilCtrl->setParameterByClass("ilportfolioexercisegui", "ass", "");
 
                 $rel = ilDatePresentation::useRelativeDates();
                 ilDatePresentation::setUseRelativeDates(false);
 
                 $text .= "<p>" . sprintf(
                     $lng->txt("prtf_exercise_submitted_info"),
                     ilDatePresentation::formatDate(new ilDateTime($submitted?->getTimestamp(), IL_CAL_DATETIME)),
                     ""
                 ) . "</p>";
                 $buttons[] = $ui->factory()->button()->standard($lng->txt("prtf_download_submission"), $dl_link);
             }
 
             ilDatePresentation::setUseRelativeDates($rel);
             $info_arr["submitted_date"] = ilDatePresentation::formatDate(new ilDateTime($submitted?->getTimestamp(), IL_CAL_DATETIME));
             $info_arr["submitted"] = true;
             if ($submitted?->getTimestamp() == "") {
                 $info_arr["submitted"] = false;
             }
         }
 
         // work instructions incl. files
 
         $tooltip = "";
 
         $inst = $ass->getInstruction();
         if ($inst) {
             $tooltip .= nl2br($inst);
         }
 
         $ass_files = $ass->getFiles();
         if (!$as_array && count($ass_files) > 0) {
             if ($tooltip) {
                 $tooltip .= "<br /><br />";
             }
 
             $items = [];
 
             foreach ($ass_files as $file) {
                 $ilCtrl->setParameterByClass("ilportfolioexercisegui", "ass", $a_assignment_id);
                 $ilCtrl->setParameterByClass("ilportfolioexercisegui", "file", urlencode($file["name"]));
                 $dl_link = $ilCtrl->getLinkTargetByClass("ilportfolioexercisegui", "downloadExcAssFile");
                 $ilCtrl->setParameterByClass("ilportfolioexercisegui", "file", "");
                 $ilCtrl->setParameterByClass("ilportfolioexercisegui", "ass", "");
 
                 $items[] = $ui->renderer()->render($ui->factory()->button()->shy($file["name"], $dl_link));
             }
             $list = $ui->factory()->listing()->unordered($items);
             $tooltip .= $ui->renderer()->render($list);
         }
 
         if ($tooltip) {
             $modal = $ui->factory()->modal()->roundtrip($lng->txt("exc_instruction"), $ui->factory()->legacy()->content($tooltip))
                 ->withCancelButtonLabel($lng->txt("close"));
             $elements[] = $modal;
             $buttons[] = $ui->factory()->button()->standard($lng->txt("exc_instruction"), '#')
                 ->withOnClick($modal->getShowSignal());
         }
 
         if ($as_array) {
             return $info_arr;
         }
 
         $elements[] = $ui->factory()->messageBox()->info($text)
             ->withLinks($links)
             ->withButtons($buttons);
 
         return $ui->renderer()->render($elements);
     }

Here is the call graph for this function:

◆ getSubmitButton()

ilPortfolioExerciseGUI::getSubmitButton ( int $ass_id )

Get submit link.

Exceptions

ilCtrlException

Definition at line 303 of file class.ilPortfolioExerciseGUI.php.

References $ctrl, $lng, $ui, ilExcAssMemberState\getInstanceByIds(), null, and ilLanguage\txt().

Referenced by getActionButtons().

      : ?\ILIAS\UI\Component\Button\Primary {
         $ilCtrl = $this->ctrl;
         $ui = $this->ui;
         $lng = $this->lng;
 
         $state = ilExcAssMemberState::getInstanceByIds($ass_id, $this->user_id);
 
         if ($state->isSubmissionAllowed()) {
             $ilCtrl->setParameterByClass("ilportfolioexercisegui", "ass", $ass_id);
             $submit_link = $ilCtrl->getLinkTargetByClass("ilportfolioexercisegui", "finalize");
             $ilCtrl->setParameterByClass("ilportfolioexercisegui", "ass", "");
             $button = $ui->factory()->button()->primary($lng->txt("prtf_finalize_portfolio"), $submit_link);
             return $button;
         }
         return null;
     }