ilExerciseSubmissionFeedbackGUI Class Reference

Collaboration diagram for ilExerciseSubmissionFeedbackGUI:

Public Member Functions
	__construct (InternalDomainService $domain, InternalGUIService $gui, ?ilObjExercise $exercise, ILIAS\Exercise\Notification\NotificationManager $notification)
	executeCommand ()
	getComponents (int $ass_id, int $usr_id)

Protected Member Functions
	showFeedbackForm ()
	getFeedbackForm ()
	validateAndSubmitFeedbackForm ()
	saveCommentForLearners ()

Protected Attributes
InternalDomainService	$domain
InternalGUIService	$gui
ilObjExercise	$exercise
ILIAS Exercise Notification NotificationManager	$notification

Detailed Description

Author

Thomas Famula famul.nosp@m.a@le.nosp@m.ifos..nosp@m.de

Definition at line 24 of file class.ilExerciseSubmissionFeedbackGUI.php.

Constructor & Destructor Documentation

__construct()

ilExerciseSubmissionFeedbackGUI::__construct	(	InternalDomainService	$domain,
		InternalGUIService	$gui,
		?ilObjExercise	$exercise,
		ILIAS\Exercise\Notification\NotificationManager	$notification
	)

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

References $domain, $exercise, $gui, $lng, $notification, and ILIAS\UI\examples\Symbol\Glyph\Notification\notification().

      {
        $this->domain = $domain;
        $this->gui = $gui;
        $lng = $domain->lng();
        $lng->loadLanguageModule("exc");
        $this->exercise = $exercise;
        $this->notification = $notification;
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilExerciseSubmissionFeedbackGUI::executeCommand

(

)

Definition at line 45 of file class.ilExerciseSubmissionFeedbackGUI.php.

                                    : void
    {
        $ctrl = $this->gui->ctrl();

        $next_class = $ctrl->getNextClass($this);
        $cmd = $ctrl->getCmd("showFeedbackForm");

        switch ($next_class) {
            default:
                if (in_array($cmd, [
                    "showFeedbackForm",
                    "validateAndSubmitFeedbackForm",
                    "saveCommentForLearners"
                ])) {
                    $this->$cmd();
                }
        }
    }

getComponents()

ilExerciseSubmissionFeedbackGUI::getComponents	(	int	$ass_id,
		int	$usr_id
	)

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

References $components, and $lng.

                                                           : array
    {
        $lng = $this->domain->lng();
        $ctrl = $this->gui->ctrl();

        $ctrl->setParameter($this, "ass_id", $ass_id);
        $ctrl->setParameter($this, "member_id", $usr_id);

        $components = $this
            ->gui
            ->modal($lng->txt("exc_tbl_action_feedback_text"))
            ->getAsyncTriggerButtonComponents(
                $lng->txt("exc_tbl_action_feedback_text"),
                $ctrl->getLinkTarget($this, "showFeedbackForm", "", true),
                true
            );

        return $components;
    }

getFeedbackForm()

ilExerciseSubmissionFeedbackGUI::getFeedbackForm ( )

protected

Definition at line 93 of file class.ilExerciseSubmissionFeedbackGUI.php.

References $ass_id, $lng, and $user_id.

Referenced by showFeedbackForm(), and validateAndSubmitFeedbackForm().

                                        : \ILIAS\Repository\Form\FormAdapterGUI
    {
        $lng = $this->domain->lng();
        $ctrl = $this->gui->ctrl();
        $request = $this->gui->request();

        $ass_id = $request->getAssId();
        $ass = $this->domain->assignment()->getAssignment($ass_id);
        $user_id = $request->getMemberId();

        $ctrl->setParameter($this, "ass_id", $ass_id);
        $ctrl->setParameter($this, "member_id", $user_id);

        $form = $this
            ->gui
            ->form(self::class, "validateAndSubmitFeedbackForm")
            ->asyncModal()
            ->textarea(
                "comment",
                $lng->txt("exc_comment_for_learner"),
                $lng->txt("exc_comment_for_learner_info"),
                $ass->getMemberStatus($user_id)->getComment()
            );

        return $form;
    }

Here is the caller graph for this function:

saveCommentForLearners()

ilExerciseSubmissionFeedbackGUI::saveCommentForLearners ( )

protected

Definition at line 144 of file class.ilExerciseSubmissionFeedbackGUI.php.

References $ass_id, $comment, $user_id, ILIAS\UI\examples\Symbol\Glyph\Notification\notification(), and ilUtil\stripSlashes().

                                               : void
    {
        $ctrl = $this->gui->ctrl();
        $request = $this->gui->request();

        $ass_id = $request->getAssId();
        $ass = $this->domain->assignment()->getAssignment($ass_id);
        $user_id = $request->getMemberId();
        $comment = trim($request->getComment());

        if ($ass_id && $user_id) {
            $submission = new ilExSubmission($ass, $user_id);
            $user_ids = $submission->getUserIds();

            $all_members = new ilExerciseMembers($this->exercise);
            $all_members = $all_members->getMembers();

            $reci_ids = array();
            foreach ($user_ids as $user_id) {
                if (in_array($user_id, $all_members)) {
                    $member_status = $ass->getMemberStatus($user_id);
                    $member_status->setComment(ilUtil::stripSlashes($comment));
                    $member_status->setFeedback(true);
                    $member_status->update();

                    if (trim($comment) !== '' && trim($comment) !== '0') {
                        $reci_ids[] = $user_id;
                    }
                }
            }

            if ($reci_ids !== []) {
                // send notification
                $this->notification->sendFeedbackNotification(
                    $ass_id,
                    $reci_ids,
                    "",
                    true
                );
            }
        }

        $ctrl->redirectByClass("ilexercisemanagementgui", $request->getParticipantId()
            ? "showParticipant"
            : "members");
    }

Here is the call graph for this function:

showFeedbackForm()

ilExerciseSubmissionFeedbackGUI::showFeedbackForm ( )

protected

Definition at line 84 of file class.ilExerciseSubmissionFeedbackGUI.php.

References $lng, ILIAS\Repository\form(), getFeedbackForm(), and send().

                                         : void
    {
        $lng = $this->domain->lng();
        $this->gui
            ->modal($lng->txt("exc_tbl_action_feedback_text"))
            ->form($this->getFeedbackForm())
            ->send();
    }

Here is the call graph for this function:

validateAndSubmitFeedbackForm()

ilExerciseSubmissionFeedbackGUI::validateAndSubmitFeedbackForm ( )

protected

Definition at line 120 of file class.ilExerciseSubmissionFeedbackGUI.php.

References $ass_id, $comment, $lng, $user_id, ILIAS\Repository\form(), and getFeedbackForm().

                                                      : void
    {
        $lng = $this->domain->lng();
        $ctrl = $this->gui->ctrl();
        $request = $this->gui->request();
        $form = $this->getFeedbackForm();
        if (!$form->isValid()) {
            $this->gui->modal($lng->txt("exc_tbl_action_feedback_text"))
                      ->form($form)
                      ->send();
        }

        $user_id = $request->getMemberId();
        $ass_id = $request->getAssId();
        $comment = $form->getData("comment");

        $ctrl->setParameter($this, "member_id", $user_id);
        $ctrl->setParameter($this, "ass_id", $ass_id);
        $ctrl->setParameter($this, "comment", $comment);

        $target = $ctrl->getLinkTarget($this, "saveCommentForLearners");
        $this->gui->send("<script>window.location.href = '" . $target . "';</script>");
    }

Here is the call graph for this function:

Field Documentation

$domain

InternalDomainService ilExerciseSubmissionFeedbackGUI::$domain

protected

Definition at line 26 of file class.ilExerciseSubmissionFeedbackGUI.php.

Referenced by __construct().

$exercise

ilObjExercise ilExerciseSubmissionFeedbackGUI::$exercise

protected

Definition at line 28 of file class.ilExerciseSubmissionFeedbackGUI.php.

Referenced by __construct().

$gui

InternalGUIService ilExerciseSubmissionFeedbackGUI::$gui

protected

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

Referenced by __construct().

$notification

ILIAS Exercise Notification NotificationManager ilExerciseSubmissionFeedbackGUI::$notification

protected

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

Referenced by __construct().

---

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

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