Collaboration diagram for ilBlogExerciseGUI:

Public Member Functions
	__construct ($a_node_id)

	executeCommand ()

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

	getDownloadSubmissionButton (int $ass_id)
	Get download button. More...

	getActionButtons ()
	Get action buttons. More...

Static Public Member Functions
static	checkExercise ($a_node_id)

Protected Member Functions
	downloadExcAssFile ()

	downloadExcSubFile ()

	finalize ()
	Finalize and submit blog to exercise. More...

Static Protected Member Functions
static	getExerciseInfo ($a_assignment_id)

Protected Attributes
	$ctrl

	$user

	$lng

	$node_id

	$ass_id

	$file

	$ui

Detailed Description

Class ilBlogExerciseGUI.

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

ilBlogExerciseGUI:

Definition at line 12 of file class.ilBlogExerciseGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilBlogExerciseGUI::__construct ( $a_node_id )

Definition at line 38 of file class.ilBlogExerciseGUI.php.

References $_GET, $DIC, ilUtil\stripSlashes(), ui(), and user().

     {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->user = $DIC->user();
         $this->lng = $DIC->language();
         $this->node_id = $a_node_id;
         $this->ass_id = (int) $_GET["ass"];
         $this->file = trim(ilUtil::stripSlashes($_GET["file"]));
         $this->ui = $DIC->ui();
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkExercise()

static ilBlogExerciseGUI::checkExercise ( $a_node_id )

static

Definition at line 71 of file class.ilBlogExerciseGUI.php.

     {
         $be = new ilBlogExercise($a_node_id);
 
         foreach ($be->getAssignmentsOfBlog() as $ass) {
             $part = self::getExerciseInfo($ass["ass_id"]);
             if ($part) {
                 $info[] = $part;
             }
         }
         if (sizeof($info)) {
             return implode("<br />", $info);
         }
         return "";
     }

◆ downloadExcAssFile()

ilBlogExerciseGUI::downloadExcAssFile ( )

protected

Definition at line 195 of file class.ilBlogExerciseGUI.php.

References $file, and ilUtil\deliverFile().

     {
         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) {
                         ilUtil::deliverFile($file["fullpath"], $file["name"]);
                     }
                 }
             }
         }
     }

Here is the call graph for this function:

◆ downloadExcSubFile()

ilBlogExerciseGUI::downloadExcSubFile ( )

protected

Definition at line 210 of file class.ilBlogExerciseGUI.php.

References $ilUser, $user, ilObjUser\_lookupName(), ilObject\_lookupTitle(), ilUtil\deliverFile(), and ilExSubmission\getFiles().

     {
         $ilUser = $this->user;
                 
         $ass = new ilExAssignment($this->ass_id);
         $submission = new ilExSubmission($ass, $ilUser->getId());
         $submitted = $submission->getFiles();
         if (count($submitted) > 0) {
             $submitted = array_pop($submitted);
 
             $user_data = ilObjUser::_lookupName($submitted["user_id"]);
             $title = ilObject::_lookupTitle($submitted["obj_id"]) . " - " .
                 $ass->getTitle() . " - " .
                 $user_data["firstname"] . " " .
                 $user_data["lastname"] . " (" .
                 $user_data["login"] . ").zip";
 
             ilUtil::deliverFile($submitted["filename"], $title);
         }
     }

Here is the call graph for this function:

◆ executeCommand()

ilBlogExerciseGUI::executeCommand ( )

Definition at line 51 of file class.ilBlogExerciseGUI.php.

References $ctrl, and $ilCtrl.

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

◆ finalize()

ilBlogExerciseGUI::finalize ( )

protected

Finalize and submit blog to exercise.

Definition at line 234 of file class.ilBlogExerciseGUI.php.

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

     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
         
         $exc_gui = ilExSubmissionObjectGUI::initGUIForSubmit($this->ass_id);
         $exc_gui->submitBlog($this->node_id);
 
         ilUtil::sendSuccess($lng->txt("blog_finalized"), true);
         $ilCtrl->returnToParent($this);
     }

Here is the call graph for this function:

◆ getActionButtons()

ilBlogExerciseGUI::getActionButtons ( )

Get action buttons.

Returns: array

Definition at line 304 of file class.ilBlogExerciseGUI.php.

References $ass_id, $exercise, getDownloadSubmissionButton(), and getSubmitButton().

     {
         $be = new ilBlogExercise($this->node_id);
 
         $buttons = [];
         foreach ($be->getAssignmentsOfBlog() as $exercise) {
             $ass_id = $exercise["ass_id"];
             $buttons[$ass_id] = [];
             $submit_button = $this->getSubmitButton($ass_id);
             if ($submit_button != null) {
                 $buttons[$ass_id][] = $submit_button;
             }
             $download_button = $this->getDownloadSubmissionButton($ass_id);
             if ($download_button != null) {
                 $buttons[$ass_id][] = $download_button;
             }
         }
 
         return $buttons;
     }

Here is the call graph for this function:

◆ getDownloadSubmissionButton()

ilBlogExerciseGUI::getDownloadSubmissionButton ( int $ass_id )

Get download button.

Parameters

Definition at line 276 of file class.ilBlogExerciseGUI.php.

References $ctrl, $ilCtrl, $lng, $ui, ilExSubmission\getSelectedObject(), and user().

Referenced by getActionButtons().

     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
         $ui = $this->ui;
 
         // submitted files
         $submission = new ilExSubmission(new ilExAssignment($ass_id), $this->user->getId());
         if ($submission->hasSubmitted()) {
             // #16888
             $submitted = $submission->getSelectedObject();
             if ($submitted["ts"] != "") {
                 $ilCtrl->setParameterByClass("ilblogexercisegui", "ass", $ass_id);
                 $dl_link = $ilCtrl->getLinkTargetByClass("ilblogexercisegui", "downloadExcSubFile");
                 $ilCtrl->setParameterByClass("ilblogexercisegui", "ass", "");
                 $button = $ui->factory()->button()->standard($lng->txt("blog_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 ilBlogExerciseGUI::getExerciseInfo ( $a_assignment_id )

staticprotected

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

References $DIC, $file, $ilCtrl, $ilUser, $lng, $ui, ilObject\_getAllReferences(), ilLink\_getStaticLink(), ilObject\_lookupTitle(), ilDatePresentation\formatDate(), ilExSubmission\getSelectedObject(), IL_CAL_DATETIME, ilDatePresentation\setUseRelativeDates(), and ilDatePresentation\useRelativeDates().

     {
         global $DIC;
 
         $ui = $DIC->ui();
 
         $links = [];
         $buttons = [];
         $elements = [];
 
         $lng = $DIC->language();
         $ilCtrl = $DIC->ctrl();
         $ilUser = $DIC->user();
                     
         $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
         $exc_ref_id = array_shift(ilObject::_getAllReferences($exercise_id));
         $exc_link = ilLink::_getStaticLink($exc_ref_id, "exc");
 
         $text = sprintf(
             $lng->txt("blog_exercise_info"),
             $ass->getTitle(),
             ilObject::_lookupTitle($exercise_id)
         );
         $links[] = $ui->factory()->link()->standard(ilObject::_lookupTitle($exercise_id), $exc_link);
         
         // submit button
         if (!$times_up) {
             $ilCtrl->setParameterByClass("ilblogexercisegui", "ass", $a_assignment_id);
             $submit_link = $ilCtrl->getLinkTargetByClass("ilblogexercisegui", "finalize");
             $ilCtrl->setParameterByClass("ilblogexercisegui", "ass", "");
 
             $buttons[] = $ui->factory()->button()->primary($lng->txt("blog_finalize_blog"), $submit_link);
         }
         
         // submitted files
         $submission = new ilExSubmission($ass, $ilUser->getId());
         if ($submission->hasSubmitted()) {
             // #16888
             $submitted = $submission->getSelectedObject();
             
             $ilCtrl->setParameterByClass("ilblogexercisegui", "ass", $a_assignment_id);
             $dl_link = $ilCtrl->getLinkTargetByClass("ilblogexercisegui", "downloadExcSubFile");
             $ilCtrl->setParameterByClass("ilblogexercisegui", "ass", "");
             
             $rel = ilDatePresentation::useRelativeDates();
             ilDatePresentation::setUseRelativeDates(false);
 
             $text .= "<br />" . sprintf(
                 $lng->txt("blog_exercise_submitted_info"),
                 ilDatePresentation::formatDate(new ilDateTime($submitted["ts"], IL_CAL_DATETIME)),
                 ""
             );
             
             ilDatePresentation::setUseRelativeDates($rel);
             $buttons[] = $ui->factory()->button()->standard($lng->txt("blog_download_submission"), $dl_link);
         }
         
         
         // work instructions incl. files
         
         $tooltip = "";
 
         $inst = $ass->getInstruction();
         if ($inst) {
             $tooltip .= nl2br($inst);
         }
 
         $ass_files = $ass->getFiles();
         if (count($ass_files) > 0) {
             $tooltip .= "<br /><br />";
             
             foreach ($ass_files as $file) {
                 $ilCtrl->setParameterByClass("ilblogexercisegui", "ass", $a_assignment_id);
                 $ilCtrl->setParameterByClass("ilblogexercisegui", "file", urlencode($file["name"]));
                 $dl_link = $ilCtrl->getLinkTargetByClass("ilblogexercisegui", "downloadExcAssFile");
                 $ilCtrl->setParameterByClass("ilblogexercisegui", "file", "");
                 $ilCtrl->setParameterByClass("ilblogexercisegui", "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($tooltip))
                 ->withCancelButtonLabel("close");
             $elements[] = $modal;
             $buttons[] = $ui->factory()->button()->standard($lng->txt("exc_instruction"), '#')
                 ->withOnClick($modal->getShowSignal());
         }
 
         $elements[] = $ui->factory()->messageBox()->info($text)
             ->withLinks($links)
             ->withButtons($buttons);
 
         return $ui->renderer()->render($elements);
     }

Here is the call graph for this function:

◆ getSubmitButton()

ilBlogExerciseGUI::getSubmitButton ( int $ass_id )

Get submit link.

Parameters

int $ass_id

Returns: object

Definition at line 252 of file class.ilBlogExerciseGUI.php.

References $ctrl, $ilCtrl, $lng, $ui, ilExcAssMemberState\getInstanceByIds(), and user().

Referenced by getActionButtons().

     {
         $ilCtrl = $this->ctrl;
         $ui = $this->ui;
         $lng = $this->lng;
 
         $state = ilExcAssMemberState::getInstanceByIds($ass_id, $this->user->getId());
 
         if ($state->isSubmissionAllowed()) {
             $ilCtrl->setParameterByClass("ilblogexercisegui", "ass", $ass_id);
             $submit_link = $ilCtrl->getLinkTargetByClass("ilblogexercisegui", "finalize");
             $ilCtrl->setParameterByClass("ilblogexercisegui", "ass", "");
             $button = $ui->factory()->button()->primary($lng->txt("blog_finalize_blog"), $submit_link);
             return $button;
         }
         return null;
     }