Collaboration diagram for ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI:

Public Member Functions
	__construct (\ilObjExercise $exc, MandatoryAssignmentsManager $mandatory_manager, InternalDomainService $domain_service, InternalGUIService $gui_service)

	build (Assignment $ass, int $user_id)

	getSections (bool $include_schedule=true, bool $overview=false)

	getSectionTitle (string $sec)

	getLeadText ()

	getHeadProperty (string $type)

	getAdditionalHeadProperties ()

	getInstructionsHidden ()

	addAdditionalHeadProperty (string $prop, string $val)

	addProperty (string $section, string $prop, string $val)

	getProperties (string $section)

	addAction (string $section, Component $button_or_link)

	getActions (string $section)

	setMainAction (string $section, ButtonPrimary $button)

	getMainAction (string $section)

	addView (string $id, string $txt, string $url)

	getViews ()

Data Fields
const	PROP_DEADLINE = "deadline"

const	PROP_REQUIREMENT = "requirement"

const	PROP_SUBMISSION = "submission"

const	PROP_TYPE = "type"

const	PROP_GRADING = "grading"

const	PROP_MARK = "mark"

const	SEC_INSTRUCTIONS = "instructions"

const	SEC_INSTRUCTIONS_OV = "instructions_overview"

const	SEC_FILES = "files"

const	SEC_SCHEDULE = "schedule"

const	SEC_TEAM = "team"

const	SEC_SUBMISSION = "submission"

const	SEC_PEER_FEEDBACK = "peer_feedback"

const	SEC_TUTOR_EVAL = "tutor_eval"

const	SEC_SAMPLE_SOLUTION = "sample_solution"

Protected Member Functions
	setLeadText (string $text)

	setInstructionsHidden (bool $hidden)

	setHeadProperty (string $type, string $prop, string $val)

	buildHead ()

	buildBody ()

	buildInstructions ()

	buildSchedule ()

	builPublicSubmissions ()

	buildFiles ()

	buildSubmission ()

	buildPeerFeedback ()

	buildSampleSolution ()

	buildSubmissionFeedback (bool $a_show_global_feedback)

	getTimeString (int $a_deadline)
	Get time string for deadline. More...

	getSubmissionLink (string $a_cmd, ?array $a_params=null)

	getIconForStatus (string $status, int $variant=\ilLPStatusIcons::ICON_VARIANT_LONG)
	Get the rendered icon for a status (failed, passed or not graded). More...

Protected Attributes
InternalDomainService	$domain

InternalGUIService	$gui

ilLanguage	$lng

MandatoryAssignmentsManager	$mandatory_manager

ilCtrl	$ctrl

ilExAssignmentTypes	$types

int	$user_builded = 0

int	$ass_builded = 0

ilExcAssMemberState	$state

ilExSubmission	$submission

ilExAssignmentTypesGUI	$types_gui

ilObjExercise	$exc

ilExAssignment	$ex_ass

ILIAS MediaObjects MediaType MediaTypeManager	$media_type

Assignment	$assignment

ilExAssignmentInfo	$info

int	$user_id

string	$lead_text = ""

array	$head_properties = []

array	$properties = []

array	$actions = []

array	$views = []

array	$main_action = []

array	$additional_head_properties = []

bool	$instructions_hidden = false

Detailed Description

Definition at line 31 of file PropertyAndActionBuilderUI.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::__construct	(	\ilObjExercise	$exc,
		MandatoryAssignmentsManager	$mandatory_manager,
		InternalDomainService	$domain_service,
		InternalGUIService	$gui_service
	)

Definition at line 77 of file PropertyAndActionBuilderUI.php.

      {
        global $DIC;
 
        $this->exc = $exc;
        $this->media_type = $DIC->mediaObjects()->internal()->domain()->mediaType();
        $this->domain = $domain_service;
        $this->gui = $gui_service;
        $this->lng = $domain_service->lng();
        $this->mandatory_manager = $mandatory_manager;
        $this->lng->loadLanguageModule("exc");
        $this->ctrl = $gui_service->ctrl();
        $this->types_gui = $gui_service->assignment()->types();
        $this->types = \ilExAssignmentTypes::getInstance();
    }

References $DIC, ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI\$exc, ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI\$mandatory_manager, ILIAS\Exercise\InternalGUIService\assignment(), ILIAS\Repository\ctrl(), ilExAssignmentTypes\getInstance(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ addAction()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::addAction	(	string	$section,
		Component	$button_or_link
	)

Definition at line 207 of file PropertyAndActionBuilderUI.php.

                                                                         : void
    {
        $this->actions[$section][] = $button_or_link;
    }

◆ addAdditionalHeadProperty()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::addAdditionalHeadProperty	(	string	$prop,
		string	$val
	)

Definition at line 186 of file PropertyAndActionBuilderUI.php.

                                                                        : void
    {
        $this->additional_head_properties[] = [
            "prop" => $prop,
            "val" => $val
        ];
    }

◆ addProperty()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::addProperty	(	string	$section,
		string	$prop,
		string	$val
	)

Definition at line 194 of file PropertyAndActionBuilderUI.php.

                                                                           : void
    {
        $this->properties[$section][] = [
            "prop" => $prop,
            "val" => $val
        ];
    }

◆ addView()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::addView	(	string	$id,
		string	$txt,
		string	$url
	)

Definition at line 227 of file PropertyAndActionBuilderUI.php.

                                                                 : void
    {
        $this->views[] = [
            "id" => $id,
            "txt" => $txt,
            "url" => $url
        ];
    }

References ILIAS\Exercise\Assignment\Assignment\$id, $txt, and $url.

◆ build()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::build	(	Assignment	$ass,
		int	$user_id
	)

Definition at line 97 of file PropertyAndActionBuilderUI.php.

     : void {
        if ($this->user_builded === $user_id && $this->ass_builded === $ass->getId()) {
            return;
        }
        $this->assignment = $ass;
        $this->user_id = $user_id;
        $this->state = \ilExcAssMemberState::getInstanceByIds($ass->getId(), $user_id);
        $this->info = new \ilExAssignmentInfo($ass->getId(), $user_id);
        $this->ex_ass = new \ilExAssignment($this->assignment->getId());
        $this->submission = new \ilExSubmission($this->ex_ass, $user_id);
        $this->lead_text = "";
        $this->head_properties = [];
        $this->views = [];
        $this->additional_head_properties = [];
        $this->main_action = [];
        $this->actions = [];
        $this->buildHead();
        $this->buildBody();
        $this->user_builded = $user_id;
        $this->ass_builded = $ass->getId();
    }

Referenced by ILIAS\Exercise\Assignment\ItemBuilderUI\getItem(), ILIAS\Exercise\Assignment\PanelBuilderUI\getPanel(), and ILIAS\Exercise\Assignment\PanelBuilderUI\getPanelViews().

Here is the caller graph for this function:

◆ buildBody()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::buildBody ( )

protected

Definition at line 439 of file PropertyAndActionBuilderUI.php.

                                  : void
    {
        // main view
        $this->ctrl->setParameterByClass(\ilAssignmentPresentationGUI::class, "ass_id", $this->assignment->getId());
        $this->addView(
            "ass",
            $this->lng->txt("overview"),
            $this->ctrl->getLinkTargetByClass(\ilAssignmentPresentationGUI::class, "")
        );
 
        if ($this->state->areInstructionsVisible()) {
            $this->buildInstructions();
            $this->buildFiles();
        } else {
            $this->setInstructionsHidden(true);
        }
 
        $this->buildSchedule();
 
        if ($this->state->hasSubmissionStarted()) {
            $this->buildSubmission();
            $this->buildPeerFeedback();
            $this->buildSampleSolution();
        }
    }

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

Here is the call graph for this function:

◆ buildFiles()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::buildFiles ( )

protected

Definition at line 604 of file PropertyAndActionBuilderUI.php.

                                   : void
    {
        $lng = $this->lng;
        $ui_factory = $this->gui->ui()->factory();
        $ui_renderer = $this->gui->ui()->renderer();
 
        $ass = $this->ex_ass;
        $files = $ass->getFiles();
        if (count($files) > 0) {
            $cnt = 0;
            foreach ($files as $file) {
                $cnt++;
                // get mime type
                //$mime = \ilObjMediaObject::getMimeType($file['fullpath']);
                $mime = $file["mime"] ?? "";
                $output_filename = htmlspecialchars($file['name'] ?? "");
 
                if ($this->media_type->isImage($mime)) {
                    $image = $ui_factory->image()->responsive($file['fullpath'], $output_filename);
                    $glyph_lens = $ui_factory->symbol()->glyph()->enlarge();
                    $button_lens = $ui_factory->button()->standard(
                        $lng->txt("exc_fullscreen"),
                        '#'
                    )->withSymbol($glyph_lens);
 
                    $modal_page = $ui_factory->modal()->lightboxImagePage($image, $output_filename);
                    $modal = $ui_factory->modal()->lightbox($modal_page);
 
                    $image = $image->withAction($modal->getShowSignal());
                    $image_lens = $button_lens->withOnClick($modal->getShowSignal());
 
                    $img_tpl = new \ilTemplate("tpl.image_file.html", true, true, "components/ILIAS/Exercise");
                    $img_tpl->setCurrentBlock("image_content");
                    $img_tpl->setVariable("MODAL", $ui_renderer->render($modal));
                    $img_tpl->setVariable("IMAGE", $ui_renderer->render($image));
                    $img_tpl->setvariable("IMAGE_LENS", $ui_renderer->render($image_lens));
                    $img_tpl->parseCurrentBlock();
 
                    $this->addProperty(
                        self::SEC_FILES,
                        $output_filename,
                        $img_tpl->get()
                    );
 
                } elseif ($this->media_type->isAudio($mime) || $this->media_type->isVideo($mime)) {
                    $media_tpl = new \ilTemplate("tpl.media_file.html", true, true, "components/ILIAS/Exercise");
 
                    if ($this->media_type->isAudio($mime)) {
                        $p = $ui_factory->player()->audio($file['fullpath']);
                    } else {
                        $p = $ui_factory->player()->video($file['fullpath']);
                    }
                    $media_tpl->setVariable("MEDIA", $ui_renderer->render($p));
 
                    $but = $ui_factory->button()->shy(
                        $lng->txt("download"),
                        $this->getSubmissionLink("downloadFile", array("file" => urlencode($file["name"])))
                    );
                    $media_tpl->setVariable("DOWNLOAD_BUTTON", $ui_renderer->render($but));
                    $this->addProperty(
                        self::SEC_FILES,
                        $output_filename,
                        $media_tpl->get()
                    );
                } else {
                    $l = $ui_factory->link()->standard(
                        $lng->txt("download"),
                        $this->getSubmissionLink("downloadFile", array("file" => urlencode($file["name"])))
                    );
                    $this->addProperty(
                        self::SEC_FILES,
                        $output_filename,
                        $ui_renderer->render($l)
                    );
                }
            }
        }
    }

References $lng.

◆ buildHead()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::buildHead ( )

protected

Definition at line 241 of file PropertyAndActionBuilderUI.php.

                                  : void
    {
        $state = $this->state;
        $lng = $this->lng;
 
        // after official deadline...
        if ($state->exceededOfficialDeadline()) {
 
            // both submission and peer review ended
            if ($state->hasEnded()) {
                $this->setLeadText(
                    $lng->txt("exc_ended")
                );
            } else {
                $this->setLeadText(
                    $state->getPeerReviewLeadText()
                );
            }
 
            $this->setHeadProperty(
                self::PROP_DEADLINE,
                $lng->txt("exc_ended_on"),
                $state->getCommonDeadlinePresentation()
            );
 
            // #14077 // this currently shows the feedback deadline during grace period
            if ($state->getPeerReviewDeadline()) {
                $this->addAdditionalHeadProperty(
                    $lng->txt("exc_peer_review_deadline"),
                    $state->getPeerReviewDeadlinePresentation()
                );
            }
            // not started yet
        } elseif (!$state->hasGenerallyStarted()) {
            if ($state->getRelativeDeadline()) {
                $prop = $lng->txt("exc_earliest_start_time");
            } else {
                $prop = $lng->txt("exc_starting_on");
            }
            $this->setLeadText(
                $prop . " " . $state->getGeneralStartPresentation()
            );
            $this->setHeadProperty(
                self::PROP_DEADLINE,
                $prop,
                $state->getGeneralStartPresentation()
            );
        } else {
            // deadline, but not reached
            if ($state->getCommonDeadline() > 0) {
                $this->setLeadText(
                    $state->getRemainingTimeLeadText()
                );
                $this->setHeadProperty(
                    self::PROP_DEADLINE,
                    $lng->txt("exc_edit_until"),
                    $state->getCommonDeadlinePresentation()
                );
                // relative deadline
            } elseif ($state->getRelativeDeadline()) {          // if we only have a relative deadline (not started yet)
                $this->setHeadProperty(
                    self::PROP_DEADLINE,
                    $lng->txt("exc_rem_time_after_start"),
                    $state->getRelativeDeadlinePresentation()
                );
                $this->setLeadText(
                    $state->getRelativeDeadlineStartLeadText()
                );
 
                if ($state->getLastSubmissionOfRelativeDeadline()) {            // if we only have a relative deadline (not started yet)
                    $this->addAdditionalHeadProperty(
                        $lng->txt("exc_rel_last_submission"),
                        $state->getLastSubmissionOfRelativeDeadlinePresentation()
                    );
                }
            } elseif ($this->assignment->getDeadlineMode() === \ilExAssignment::DEADLINE_ABSOLUTE_INDIVIDUAL) {
                if ($state->needsIndividualDeadline()) {
                    if ($state->hasRequestedIndividualDeadline()) {
                        $this->setLeadText(
                            $this->lng->txt("exc_lead_wait_for_idl")
                        );
                    } else {
                        $this->setLeadText(
                            $this->lng->txt("exc_lead_request_idl")
                        );
                    }
                    $this->setHeadProperty(
                        self::PROP_DEADLINE,
                        $lng->txt("exc_deadline"),
                        $lng->txt("exc_deadline_not_set_yet")
                    );
                } else {
                    $this->setLeadText(
                        $state->getRemainingTimeLeadText()
                    );
                    $this->setHeadProperty(
                        self::PROP_DEADLINE,
                        $lng->txt("exc_edit_until"),
                        $state->getIndividualDeadlinePresentation()
                    );
                }
            } else {
                // no deadline
                $this->setLeadText(
                    $this->lng->txt("exc_submit_anytime")
                );
                $this->setHeadProperty(
                    self::PROP_DEADLINE,
                    $lng->txt("exc_edit_until"),
                    $lng->txt("exc_no_deadline")
                );
            }
 
            if ($state->getIndividualDeadline() > 0 &&
                $this->assignment->getDeadlineMode() !== \ilExAssignment::DEADLINE_ABSOLUTE_INDIVIDUAL) {
                $this->addAdditionalHeadProperty(
                    $lng->txt("exc_individual_deadline"),
                    $state->getIndividualDeadlinePresentation()
                );
            }
        }
 
        if ($this->mandatory_manager->isMandatoryForUser($this->assignment->getId(), $this->user_id)) {
            $this->setHeadProperty(
                self::PROP_REQUIREMENT,
                $lng->txt("exc_requirement"),
                $lng->txt("exc_mandatory")
            );
        } else {
            $this->setHeadProperty(
                self::PROP_REQUIREMENT,
                $lng->txt("exc_requirement"),
                $lng->txt("exc_optional")
            );
        }
 
        // submission property
        if ($this->submission->hasSubmitted()) {
            $last_sub = $this->submission->getLastSubmission();
            if ($last_sub) {
                $last_sub = \ilDatePresentation::formatDate(new \ilDateTime($last_sub, IL_CAL_DATETIME));
                $this->setHeadProperty(
                    self::PROP_SUBMISSION,
                    $this->lng->txt("exc_last_submission"),
                    $last_sub
                );
            }
        } else {
            $this->setHeadProperty(
                self::PROP_SUBMISSION,
                $this->lng->txt("exc_last_submission"),
                $this->lng->txt("exc_no_submission_yet")
            );
        }
 
        // type property
        $ass_type = $this->types->getById($this->assignment->getType());
        $this->setHeadProperty(
            self::PROP_TYPE,
            $this->lng->txt("exc_type"),
            $ass_type->getTitle()
        );
 
        // grading property
        if (!$this->state->isFuture()) {
            $status = $this->ex_ass->getMemberStatus($this->user_id)->getStatus();
            if ($status !== "") {
                $this->setHeadProperty(
                    self::PROP_GRADING,
                    $lng->txt("status"),
                    $lng->txt("exc_" . $status)
                );
            }
        }
 
        // mark
        if (!$this->state->isFuture()) {
            $mark = $this->ex_ass->getMemberStatus($this->user_id)->getMark();
            if ($mark !== "") {
                $this->setHeadProperty(
                    self::PROP_MARK,
                    $lng->txt("exc_mark"),
                    $mark
                );
            }
        }
 
        // status icon
        /*
        $tpl->setVariable(
            "ICON_STATUS",
            $this->getIconForStatus(
                $a_ass->getMemberStatus()->getStatus(),
                ilLPStatusIcons::ICON_VARIANT_SHORT
            )
        );*/
    }

References $lng, ilExAssignment\DEADLINE_ABSOLUTE_INDIVIDUAL, ilDatePresentation\formatDate(), IL_CAL_DATETIME, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ buildInstructions()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::buildInstructions ( )

protected

Definition at line 466 of file PropertyAndActionBuilderUI.php.

                                          : void
    {
        $inst = $this->info->getInstructionInfo();
        if (count($inst) > 0) {
            $this->addProperty(
                self::SEC_INSTRUCTIONS,
                "",
                $inst["instruction"]["value"]
            );
            $link = $this->gui->ui()->factory()->link()->standard(
                $this->lng->txt("exc_show_instructions"),
                $this->ctrl->getLinkTargetByClass(\ilAssignmentPresentationGUI::class, "")
            );
            $this->addAction(
                self::SEC_INSTRUCTIONS_OV,
                $link
            );
        }
    }

References ILIAS\UI\examples\MessageBox\Info\info(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ buildPeerFeedback()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::buildPeerFeedback ( )

protected

Definition at line 734 of file PropertyAndActionBuilderUI.php.

                                          : void
    {
        if (!$this->submission->canView()) {
            return;
        }
        $peer_review_gui = $this->gui->peerReview()->getPeerReviewGUI(
            $this->ex_ass,
            $this->submission
        );
        $peer_review_gui->buildSubmissionPropertiesAndActions($this);
    }

◆ buildSampleSolution()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::buildSampleSolution ( )

protected

Definition at line 746 of file PropertyAndActionBuilderUI.php.

                                            : void
    {
        $ass = $this->ex_ass;
        $state = $this->state;
        $submission = $this->submission;
 
        $last_sub = null;
        if ($submission->hasSubmitted()) {
            $last_sub = $submission->getLastSubmission();
        }
 
        // global feedback / sample solution
        if ($ass->getFeedbackDate() === \ilExAssignment::FEEDBACK_DATE_DEADLINE) {
            $show_global_feedback = ($state->hasSubmissionEndedForAllUsers() && $ass->getFeedbackFile());
        }
        //If it is not well configured...(e.g. show solution before deadline)
        //the user can get the solution before he summit it.
        //we can check in the elseif $submission->hasSubmitted()
        elseif ($ass->getFeedbackDate() === \ilExAssignment::FEEDBACK_DATE_CUSTOM) {
            $show_global_feedback = ($ass->afterCustomDate() && $ass->getFeedbackFile());
        } else {
            $show_global_feedback = ($last_sub && $ass->getFeedbackFile());
        }
        $this->buildSubmissionFeedback($show_global_feedback);
    }

References ilExAssignment\FEEDBACK_DATE_CUSTOM, and ilExAssignment\FEEDBACK_DATE_DEADLINE.

◆ buildSchedule()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::buildSchedule ( )

protected

Exceptions

ilCtrlException

Exceptions

ilDateTimeException

Definition at line 490 of file PropertyAndActionBuilderUI.php.

                                      : void
    {
 
        $info = $this->info;
        $schedule = $info->getScheduleInfo();
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $state = $this->state;
 
        if ($state->getGeneralStart() > 0) {
            $this->addProperty(
                self::SEC_SCHEDULE,
                $schedule["start_time"]["txt"],
                $schedule["start_time"]["value"]
            );
        }
 
        if ($state->getCommonDeadline()) {              // if we have a common deadline (target timestamp)
            $this->addProperty(
                self::SEC_SCHEDULE,
                $schedule["until"]["txt"],
                $schedule["until"]["value"]
            );
        } elseif ($state->getRelativeDeadline()) {              // if we only have a relative deadline (not started yet)
            $but = "";
            if ($state->hasGenerallyStarted()) {
                $ilCtrl->setParameterByClass("ilobjexercisegui", "ass_id", $this->assignment->getId());
                $but = $this->gui->ui()->factory()->button()->primary($lng->txt("exc_start_assignment"), $ilCtrl->getLinkTargetByClass("ilobjexercisegui", "startAssignment"));
                $ilCtrl->setParameterByClass("ilobjexercisegui", "ass_id", null);
                $this->setMainAction(
                    self::SEC_SCHEDULE,
                    $but
                );
            }
            $this->addProperty(
                self::SEC_SCHEDULE,
                $schedule["time_after_start"]["txt"],
                $schedule["time_after_start"]["value"]
            );
 
            if ($state->getLastSubmissionOfRelativeDeadline()) {                // if we only have a relative deadline (not started yet)
                $this->addProperty(
                    self::SEC_SCHEDULE,
                    $lng->txt("exc_rel_last_submission"),
                    $state->getLastSubmissionOfRelativeDeadlinePresentation()
                );
            }
        } elseif ($state->needsIndividualDeadline()) {
            if ($state->hasRequestedIndividualDeadline()) {
                $this->addProperty(
                    self::SEC_SCHEDULE,
                    $this->lng->txt("exc_deadline"),
                    $this->lng->txt("exc_idl_tutor_needed")
                );
            } else {
                $this->addProperty(
                    self::SEC_SCHEDULE,
                    $this->lng->txt("exc_deadline"),
                    $this->lng->txt("exc_idl_request_and_tutor_needed")
                );
                $ilCtrl->setParameterByClass("ilobjexercisegui", "ass_id", $this->assignment->getId());
                $but = $this->gui->ui()->factory()->button()->primary($lng->txt("exc_request_deadline"), $ilCtrl->getLinkTargetByClass("ilobjexercisegui", "requestDeadline"));
                $ilCtrl->setParameterByClass("ilobjexercisegui", "ass_id", null);
                $this->setMainAction(
                    self::SEC_SCHEDULE,
                    $but
                );
            }
        }
 
        if ($state->getOfficialDeadline() > $state->getCommonDeadline()) {
            $this->addProperty(
                self::SEC_SCHEDULE,
                $schedule["individual_deadline"]["txt"],
                $schedule["individual_deadline"]["value"]
            );
        }
 
        if ($state->hasSubmissionStarted()) {
            $this->addProperty(
                self::SEC_SCHEDULE,
                $schedule["time_to_send"]["txt"],
                $schedule["time_to_send"]["value"]
            );
        }
    }

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

Here is the call graph for this function:

◆ buildSubmission()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::buildSubmission ( )

protected

Exceptions

ilCtrlException
ilDateTimeException

Definition at line 687 of file PropertyAndActionBuilderUI.php.

                                        : void
    {
 
        if (!$this->submission->canView()) {
            return;
        }
 
        $this->ctrl->setParameterByClass(
            "ilExSubmissionGUI",
            "ass_id",
            $this->assignment->getId()
        );
 
        if ($this->submission->getAssignment()->hasTeam()) {
            $team_gui = $this->gui->getTeamSubmissionGUI($this->exc, $this->submission);
            $team_gui->buildSubmissionPropertiesAndActions($this);
        }
 
        $type_gui = $this->types_gui->getById($this->ex_ass->getType());
        $type_gui->setSubmission($this->submission);
        $type_gui->setExercise($this->exc);
        $type_gui->buildSubmissionPropertiesAndActions($this);
 
        $last_sub = null;
        if ($this->submission->hasSubmitted()) {
            $last_sub = $this->submission->getLastSubmission();
            if ($last_sub) {
                $last_sub = \ilDatePresentation::formatDate(new \ilDateTime($last_sub, IL_CAL_DATETIME));
                $this->addProperty(
                    self::SEC_SUBMISSION,
                    $this->lng->txt("exc_last_submission"),
                    $last_sub
                );
            }
        } else {
            $this->addProperty(
                self::SEC_SUBMISSION,
                $this->lng->txt("exc_last_submission"),
                $this->lng->txt("exc_no_submission_yet")
            );
        }
 
        if ($this->exc->getShowSubmissions()) {
            $this->builPublicSubmissions();
        }
    }

References ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), IL_CAL_DATETIME, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ buildSubmissionFeedback()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::buildSubmissionFeedback ( bool $a_show_global_feedback )

protected

Definition at line 772 of file PropertyAndActionBuilderUI.php.

     : void {
 
        $f = $this->gui->ui()->factory();
        $r = $this->gui->ui()->renderer();
 
        $ass = $this->ex_ass;
        $feedback_id = $this->submission->getFeedbackId();
        $lng = $this->lng;
 
        $feedback_file_manager = $this->domain->assignment()->tutorFeedbackFile($ass->getId());
        $cnt_files = $feedback_file_manager->count($this->user_id);
 
 
        $lpcomment = $ass->getMemberStatus()->getComment();
        $mark = $ass->getMemberStatus()->getMark();
        $status = $ass->getMemberStatus()->getStatus();
 
        if ($lpcomment != "" ||
            $mark != "" ||
            $status !== "notgraded" ||
            $cnt_files > 0 ||
            $a_show_global_feedback) {
 
            if ($lpcomment !== "") {
                $this->addProperty(
                    self::SEC_TUTOR_EVAL,
                    $lng->txt("exc_comment"),
                    nl2br($this->gui->html()->escapeCurly($lpcomment))
                );
            }
            if ($mark !== "") {
                $this->addProperty(
                    self::SEC_TUTOR_EVAL,
                    $lng->txt("exc_mark"),
                    $mark
                );
            }
 
            if ($status !== "" && $status !== "notgraded") {
                $this->addProperty(
                    self::SEC_TUTOR_EVAL,
                    $lng->txt("status"),
                    $lng->txt("exc_" . $status)
                );
            }
 
            if ($cnt_files > 0) {
                $files = $feedback_file_manager->getFiles($this->user_id);
                foreach ($files as $file) {
                    $link = $f->link()->standard(
                        $lng->txt("download"),
                        $this->getSubmissionLink("downloadFeedbackFile", array("file" => urlencode($file)))
                    );
                    $this->addProperty(
                        self::SEC_TUTOR_EVAL,
                        $file,
                        $r->render($link)
                    );
                }
            }
 
            // #15002 - global feedback
            if ($a_show_global_feedback) {
                $link = $f->link()->standard(
                    $lng->txt("download"),
                    $this->getSubmissionLink("downloadGlobalFeedbackFile")
                );
                $this->addProperty(
                    self::SEC_SAMPLE_SOLUTION,
                    $ass->getFeedbackFile(),
                    $r->render($link)
                );
            }
        }
    }

References Vendor\Package\$f, and $lng.

◆ builPublicSubmissions()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::builPublicSubmissions ( )

protected

Definition at line 578 of file PropertyAndActionBuilderUI.php.

                                              : void
    {
        // submissions are visible, even if other users may still have a larger individual deadline
        if ($this->state->hasSubmissionEnded()) {
            $link = $this->gui->ui()->factory()->link()->standard(
                $this->lng->txt("exc_public_submission"),
                $this->getSubmissionLink("listPublicSubmissions")
            );
            $this->addAction(
                self::SEC_SUBMISSION,
                $link
            );
            $this->addView(
                "public_submissions",
                $this->lng->txt("exc_public_submission"),
                $this->getSubmissionLink("listPublicSubmissions")
            );
        } else {
            $this->addProperty(
                self::SEC_SUBMISSION,
                $this->lng->txt("exc_public_submission"),
                $this->lng->txt("exc_msg_public_submission")
            );
        }
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getActions()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::getActions ( string $section )

Definition at line 212 of file PropertyAndActionBuilderUI.php.

                                               : array
    {
        return $this->actions[$section] ?? [];
    }

◆ getAdditionalHeadProperties()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::getAdditionalHeadProperties ( )

Definition at line 158 of file PropertyAndActionBuilderUI.php.

                                                 : array
    {
        return $this->additional_head_properties;
    }

◆ getHeadProperty()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::getHeadProperty ( string $type )

Definition at line 153 of file PropertyAndActionBuilderUI.php.

                                                 : ?array
    {
        return $this->head_properties[$type] ?? null;
    }

References ILIAS\Exercise\Assignment\Assignment\$type.

◆ getIconForStatus()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::getIconForStatus	(	string	$status,
		int	$variant = `\ilLPStatusIcons::ICON_VARIANT_LONG`
	)

protected

Get the rendered icon for a status (failed, passed or not graded).

Definition at line 899 of file PropertyAndActionBuilderUI.php.

                                                                                                         : string
    {
        $icons = \ilLPStatusIcons::getInstance($variant);
        $lng = $this->lng;
 
        switch ($status) {
            case "passed":
                return $icons->renderIcon(
                    $icons->getImagePathCompleted(),
                    $lng->txt("exc_" . $status)
                );
 
            case "failed":
                return $icons->renderIcon(
                    $icons->getImagePathFailed(),
                    $lng->txt("exc_" . $status)
                );
 
            default:
                return $icons->renderIcon(
                    $icons->getImagePathNotAttempted(),
                    $lng->txt("exc_" . $status)
                );
        }
    }

References $lng, and ilLPStatusIcons\getInstance().

Here is the call graph for this function:

◆ getInstructionsHidden()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::getInstructionsHidden ( )

Definition at line 173 of file PropertyAndActionBuilderUI.php.

                                           : bool
    {
        return $this->instructions_hidden;
    }

◆ getLeadText()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::getLeadText ( )

Definition at line 148 of file PropertyAndActionBuilderUI.php.

                                 : string
    {
        return $this->lead_text;
    }

◆ getMainAction()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::getMainAction ( string $section )

Definition at line 222 of file PropertyAndActionBuilderUI.php.

                                                  : ?ButtonPrimary
    {
        return $this->main_action[$section] ?? null;
    }

◆ getProperties()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::getProperties ( string $section )

Definition at line 202 of file PropertyAndActionBuilderUI.php.

                                                  : array
    {
        return $this->properties[$section] ?? [];
    }

◆ getSections()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::getSections	(	bool	$include_schedule = `true`,
		bool	$overview = `false`
	)

Definition at line 122 of file PropertyAndActionBuilderUI.php.

                                                                                      : array
    {
        $secs = [];
        $secs[self::SEC_INSTRUCTIONS] = $this->lng->txt("exc_instruction");
        if ($overview) {
            $secs[self::SEC_INSTRUCTIONS_OV] = "";
        }
        if ($include_schedule) {
            $secs[self::SEC_SCHEDULE] = $this->lng->txt("exc_schedule");
        }
        $secs[self::SEC_FILES] = $this->lng->txt("exc_files");
        $secs[self::SEC_TEAM] = $this->lng->txt("exc_team");
        $secs[self::SEC_SUBMISSION] = $this->lng->txt("exc_submission");
        $secs[self::SEC_PEER_FEEDBACK] = $this->lng->txt("exc_peer_review");
        $secs[self::SEC_TUTOR_EVAL] = $this->lng->txt("exc_feedback_from_tutor");
        $secs[self::SEC_SAMPLE_SOLUTION] = $this->lng->txt("exc_global_feedback_file");
 
        return $secs;
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getSectionTitle()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::getSectionTitle ( string $sec )

Definition at line 142 of file PropertyAndActionBuilderUI.php.

                                                : string
    {
        $secs = $this->getSections();
        return $secs[$sec] ?? "";
    }

◆ getSubmissionLink()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::getSubmissionLink	(	string	$a_cmd,
		?array	$a_params = `null`
	)

protected

Definition at line 871 of file PropertyAndActionBuilderUI.php.

     : string {
        $ilCtrl = $this->ctrl;
 
        if (is_array($a_params)) {
            foreach ($a_params as $name => $value) {
                $ilCtrl->setParameterByClass("ilexsubmissiongui", $name, $value);
            }
        }
 
        $ilCtrl->setParameterByClass("ilexsubmissiongui", "ass_id", $this->assignment->getId());
        $url = $ilCtrl->getLinkTargetByClass([\ilAssignmentPresentationGUI::class, "ilexsubmissiongui"], $a_cmd);
        $ilCtrl->setParameterByClass("ilexsubmissiongui", "ass_id", "");
 
        if (is_array($a_params)) {
            foreach ($a_params as $name => $value) {
                $ilCtrl->setParameterByClass("ilexsubmissiongui", $name, "");
            }
        }
 
        return $url;
    }

◆ getTimeString()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::getTimeString ( int $a_deadline )

protected

Get time string for deadline.

Exceptions

ilDateTimeException

Definition at line 854 of file PropertyAndActionBuilderUI.php.

                                                     : string
    {
        $lng = $this->lng;
 
        if ($a_deadline == 0) {
            return $lng->txt("exc_submit_convenience_no_deadline");
        }
 
        if ($a_deadline - time() <= 0) {
            $time_str = $lng->txt("exc_time_over_short");
        } else {
            $time_str = \ilLegacyFormElementsUtil::period2String(new \ilDateTime($a_deadline, IL_CAL_UNIX));
        }
 
        return $time_str;
    }

References $lng, IL_CAL_UNIX, and ilLegacyFormElementsUtil\period2String().

Here is the call graph for this function:

◆ getViews()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::getViews ( )

Definition at line 236 of file PropertyAndActionBuilderUI.php.

                              : array
    {
        return $this->views;
    }

◆ setHeadProperty()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::setHeadProperty	(	string	$type,
		string	$prop,
		string	$val
	)

protected

Definition at line 178 of file PropertyAndActionBuilderUI.php.

                                                                               : void
    {
        $this->head_properties[$type] = [
            "prop" => $prop,
            "val" => $val
        ];
    }

References ILIAS\Exercise\Assignment\Assignment\$type.

◆ setInstructionsHidden()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::setInstructionsHidden ( bool $hidden )

protected

Definition at line 168 of file PropertyAndActionBuilderUI.php.

                                                          : void
    {
        $this->instructions_hidden = $hidden;
    }

◆ setLeadText()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::setLeadText ( string $text )

protected

Definition at line 163 of file PropertyAndActionBuilderUI.php.

                                                : void
    {
        $this->lead_text = $text;
    }

◆ setMainAction()

ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::setMainAction	(	string	$section,
		ButtonPrimary	$button
	)

Definition at line 217 of file PropertyAndActionBuilderUI.php.

                                                                         : void
    {
        $this->main_action[$section] = $button;
    }

Field Documentation

◆ $actions

array ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$actions = []

protected

Definition at line 71 of file PropertyAndActionBuilderUI.php.

◆ $additional_head_properties

array ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$additional_head_properties = []

protected

Definition at line 74 of file PropertyAndActionBuilderUI.php.

◆ $ass_builded

int ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$ass_builded = 0

protected

Definition at line 57 of file PropertyAndActionBuilderUI.php.

◆ $assignment

Assignment ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$assignment

protected

Definition at line 64 of file PropertyAndActionBuilderUI.php.

◆ $ctrl

ilCtrl ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$ctrl

protected

Definition at line 53 of file PropertyAndActionBuilderUI.php.

◆ $domain

InternalDomainService ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$domain

protected

Definition at line 49 of file PropertyAndActionBuilderUI.php.

◆ $ex_ass

ilExAssignment ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$ex_ass

protected

Definition at line 62 of file PropertyAndActionBuilderUI.php.

◆ $exc

ilObjExercise ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$exc

protected

Definition at line 61 of file PropertyAndActionBuilderUI.php.

Referenced by ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI\__construct().

◆ $gui

InternalGUIService ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$gui

protected

Definition at line 50 of file PropertyAndActionBuilderUI.php.

◆ $head_properties

array ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$head_properties = []

protected

Definition at line 69 of file PropertyAndActionBuilderUI.php.

◆ $info

ilExAssignmentInfo ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$info

protected

Definition at line 65 of file PropertyAndActionBuilderUI.php.

◆ $instructions_hidden

bool ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$instructions_hidden = false

protected

Definition at line 75 of file PropertyAndActionBuilderUI.php.

◆ $lead_text

string ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$lead_text = ""

protected

Definition at line 68 of file PropertyAndActionBuilderUI.php.

◆ $lng

ilLanguage ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$lng

protected

Definition at line 51 of file PropertyAndActionBuilderUI.php.

◆ $main_action

array ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$main_action = []

protected

Definition at line 73 of file PropertyAndActionBuilderUI.php.

◆ $mandatory_manager

MandatoryAssignmentsManager ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$mandatory_manager

protected

Definition at line 52 of file PropertyAndActionBuilderUI.php.

Referenced by ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI\__construct().

◆ $media_type

ILIAS MediaObjects MediaType MediaTypeManager ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$media_type

protected

Definition at line 63 of file PropertyAndActionBuilderUI.php.

◆ $properties

array ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$properties = []

protected

Definition at line 70 of file PropertyAndActionBuilderUI.php.

◆ $state

ilExcAssMemberState ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$state

protected

Definition at line 58 of file PropertyAndActionBuilderUI.php.

◆ $submission

ilExSubmission ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$submission

protected

Definition at line 59 of file PropertyAndActionBuilderUI.php.

◆ $types

ilExAssignmentTypes ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$types

protected

Definition at line 54 of file PropertyAndActionBuilderUI.php.

◆ $types_gui

ilExAssignmentTypesGUI ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$types_gui

protected

Definition at line 60 of file PropertyAndActionBuilderUI.php.

◆ $user_builded

int ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$user_builded = 0

protected

Definition at line 56 of file PropertyAndActionBuilderUI.php.

◆ $user_id

int ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$user_id

protected

Definition at line 67 of file PropertyAndActionBuilderUI.php.

◆ $views

array ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::$views = []

protected

Definition at line 72 of file PropertyAndActionBuilderUI.php.

◆ PROP_DEADLINE

const ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::PROP_DEADLINE = "deadline"

Definition at line 33 of file PropertyAndActionBuilderUI.php.

◆ PROP_GRADING

const ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::PROP_GRADING = "grading"

Definition at line 37 of file PropertyAndActionBuilderUI.php.

◆ PROP_MARK

const ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::PROP_MARK = "mark"

Definition at line 38 of file PropertyAndActionBuilderUI.php.

◆ PROP_REQUIREMENT

const ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::PROP_REQUIREMENT = "requirement"

Definition at line 34 of file PropertyAndActionBuilderUI.php.

◆ PROP_SUBMISSION

const ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::PROP_SUBMISSION = "submission"

Definition at line 35 of file PropertyAndActionBuilderUI.php.

◆ PROP_TYPE

const ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::PROP_TYPE = "type"

Definition at line 36 of file PropertyAndActionBuilderUI.php.

◆ SEC_FILES

const ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::SEC_FILES = "files"

Definition at line 42 of file PropertyAndActionBuilderUI.php.

◆ SEC_INSTRUCTIONS

const ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::SEC_INSTRUCTIONS = "instructions"

Definition at line 40 of file PropertyAndActionBuilderUI.php.

◆ SEC_INSTRUCTIONS_OV

const ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::SEC_INSTRUCTIONS_OV = "instructions_overview"

Definition at line 41 of file PropertyAndActionBuilderUI.php.

◆ SEC_PEER_FEEDBACK

const ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::SEC_PEER_FEEDBACK = "peer_feedback"

Definition at line 46 of file PropertyAndActionBuilderUI.php.

◆ SEC_SAMPLE_SOLUTION

const ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::SEC_SAMPLE_SOLUTION = "sample_solution"

Definition at line 48 of file PropertyAndActionBuilderUI.php.

◆ SEC_SCHEDULE

const ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::SEC_SCHEDULE = "schedule"

Definition at line 43 of file PropertyAndActionBuilderUI.php.

◆ SEC_SUBMISSION

const ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::SEC_SUBMISSION = "submission"

Definition at line 45 of file PropertyAndActionBuilderUI.php.

◆ SEC_TEAM

const ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::SEC_TEAM = "team"

Definition at line 44 of file PropertyAndActionBuilderUI.php.

◆ SEC_TUTOR_EVAL

const ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI::SEC_TUTOR_EVAL = "tutor_eval"

Definition at line 47 of file PropertyAndActionBuilderUI.php.

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

components/ILIAS/Exercise/Assignment/PropertyAndActionBuilderUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAction()

◆ addAdditionalHeadProperty()

◆ addProperty()

◆ addView()

◆ build()

◆ buildBody()

◆ buildFiles()

◆ buildHead()

◆ buildInstructions()

◆ buildPeerFeedback()

◆ buildSampleSolution()

◆ buildSchedule()

◆ buildSubmission()

◆ buildSubmissionFeedback()

◆ builPublicSubmissions()

◆ getActions()

◆ getAdditionalHeadProperties()

◆ getHeadProperty()

◆ getIconForStatus()

◆ getInstructionsHidden()

◆ getLeadText()

◆ getMainAction()

◆ getProperties()

◆ getSections()

◆ getSectionTitle()

◆ getSubmissionLink()

◆ getTimeString()

◆ getViews()

◆ setHeadProperty()

◆ setInstructionsHidden()

◆ setLeadText()

◆ setMainAction()

Field Documentation

◆ $actions

◆ $additional_head_properties

◆ $ass_builded

◆ $assignment

◆ $ctrl

◆ $domain

◆ $ex_ass

◆ $exc

◆ $gui

◆ $head_properties

◆ $info

◆ $instructions_hidden

◆ $lead_text

◆ $lng

◆ $main_action

◆ $mandatory_manager

◆ $media_type

◆ $properties

◆ $state

◆ $submission

◆ $types

◆ $types_gui

◆ $user_builded

◆ $user_id

◆ $views

◆ PROP_DEADLINE

◆ PROP_GRADING

◆ PROP_MARK

◆ PROP_REQUIREMENT

◆ PROP_SUBMISSION

◆ PROP_TYPE

◆ SEC_FILES

◆ SEC_INSTRUCTIONS

◆ SEC_INSTRUCTIONS_OV

◆ SEC_PEER_FEEDBACK

◆ SEC_SAMPLE_SOLUTION

◆ SEC_SCHEDULE

◆ SEC_SUBMISSION

◆ SEC_TEAM