Team wiki type gui implementations. More...

Inheritance diagram for ilExAssTypeWikiTeamGUI:

Collaboration diagram for ilExAssTypeWikiTeamGUI:

Public Member Functions
	__construct (protected InternalDomainService $domain, protected InternalGUIService $gui)

	executeCommand ()
	Execute command. More...

	addEditFormCustomProperties (ilPropertyFormGUI $form)
	Add custom form properties to edit form. More...

	importFormToAssignment (ilExAssignment $ass, ilPropertyFormGUI $form)
	Get values from form and put them into assignment. More...

	getFormValuesArray (ilExAssignment $ass)
	Get form values array from assignment. Returns array More...

	getOverviewContent (ilInfoScreenGUI $a_info, ilExSubmission $a_submission)
	Add overview content of submission to info screen object. More...

	getHTML (array $par)
	Get HTML. More...

	buildSubmissionPropertiesAndActions (\ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI $builder)

Public Member Functions inherited from ilExAssignmentTypeGUIInterface
	setSubmission (ilExSubmission $a_submission)
	Set submission. More...

	setExercise (ilObjExercise $a_exercise)
	Set exercise. More...

Data Fields
const	MODE_OVERVIEW = "overview"

Protected Member Functions
	renderOverviewContent (ilInfoScreenGUI $a_info, ilExSubmission $a_submission)
	Render overview content. More...

	createWiki ()
	Create wiki for assignment. More...

Protected Attributes
ilLanguage	$lng

ilCtrl	$ctrl

ilTree	$tree

ilAccessHandler	$access

Private Attributes
ilGlobalTemplateInterface	$main_tpl

Detailed Description

Team wiki type gui implementations.

Author: Alex Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de ilExAssTypeWikiTeamGUI: ilExSubmissionGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilExAssTypeWikiTeamGUI::__construct	(	protected InternalDomainService	$domain,
		protected InternalGUIService	$gui
	)

Definition at line 39 of file class.ilExAssTypeWikiTeamGUI.php.

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

       {
         $this->main_tpl = $gui->ui()->mainTemplate();
         $this->lng = $domain->lng();
         $this->ctrl = $gui->ctrl();
         $this->tree = $domain->repositoryTree();
         $this->access = $domain->access();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addEditFormCustomProperties()

ilExAssTypeWikiTeamGUI::addEditFormCustomProperties ( ilPropertyFormGUI $form )

Add custom form properties to edit form.

Implements ilExAssignmentTypeGUIInterface.

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

References $lng, ilPropertyFormGUI\addItem(), ilRadioOption\addSubItem(), ilFormPropertyGUI\setRequired(), and ilLanguage\txt().

                                                                         : void
     {
         $lng = $this->lng;
 
         // template
         $rd_template = new ilRadioGroupInputGUI($lng->txt("exc_template"), "template");
         $rd_template->setRequired(true);
         $radio_no_template = new ilRadioOption($lng->txt("exc_without_wiki_template"), "0", $lng->txt("exc_without_wiki_template_info"));
         $radio_with_template = new ilRadioOption($lng->txt("exc_with_wiki_template"), "1", $lng->txt("exc_with_wiki_template_info"));
 
         $repo = new ilRepositorySelector2InputGUI($lng->txt("wiki_exc_template"), "template_ref_id");
         $repo->setRequired(true);
         $repo->getExplorerGUI()->setSelectableTypes(array("wiki"));
         $repo->getExplorerGUI()->setTypeWhiteList(array("root", "wiki", "cat", "crs", "grp", "fold"));
         $radio_with_template->addSubItem($repo);
 
         $rd_template->addOption($radio_no_template);
         $rd_template->addOption($radio_with_template);
         $form->addItem($rd_template);
 
         // container
         $cont = new ilRepositorySelector2InputGUI($lng->txt("exc_wiki_container"), "container_ref_id");
         $cont->setRequired(true);
         $cont->setInfo($lng->txt("exc_wiki_container_info"));
         $cont->getExplorerGUI()->setSelectableTypes(array("cat", "crs", "grp", "fold"));
         $cont->getExplorerGUI()->setTypeWhiteList(array("root", "cat", "crs", "grp", "fold"));
         $form->addItem($cont);
     }

Here is the call graph for this function:

◆ buildSubmissionPropertiesAndActions()

ilExAssTypeWikiTeamGUI::buildSubmissionPropertiesAndActions ( \ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI $builder )

Implements ilExAssignmentTypeGUIInterface.

Definition at line 285 of file class.ilExAssTypeWikiTeamGUI.php.

References $ctrl, $DIC, Vendor\Package\$f, $lng, ilObject\_exists(), ilCtrl\getLinkTargetByClass(), getSubmission(), ILIAS\Repository\int(), ilCtrl\setParameterByClass(), and ilLanguage\txt().

                                                                                                                        : void
     {
         global $DIC;
 
         $f = $DIC->ui()->factory();
         $lng = $this->lng;
         $ctrl = $this->ctrl;
 
 
         $files_str = "";
         $valid_wiki = false;
 
         $submission = $this->getSubmission();
 
         $team_members = $submission->getTeam()->getMembers();
         $team_available = (count($team_members));
 
         $selected_wiki = $submission->getSelectedObject();
         if ($selected_wiki) {
             $wiki_ref_id = (int) $selected_wiki->getTitle();
 
             // #11746
             if (\ilObject::_exists($wiki_ref_id, true, "wiki") && $this->tree->isInTree($wiki_ref_id)) {
                 $wiki = new \ilObjWiki($wiki_ref_id);
                 if ($wiki->getTitle()) {
                     // #10116 / #12791
                     $ctrl->setParameterByClass("ilobjwikigui", "ref_id", $wiki_ref_id);
                     $wiki_link = ilLink::_getLink($wiki_ref_id);
                     $files_str = '<a href="' . $wiki_link .
                         '">' . $wiki->getTitle() . '</a>';
                     $valid_wiki = true;
                     $builder->addProperty(
                         $builder::SEC_SUBMISSION,
                         $lng->txt("exc_ass_team_wiki"),
                         $wiki->getTitle()
                     );
                     if ($submission->canSubmit()) {
                         $button = $f->button()->primary(
                             $lng->txt("exc_edit_wiki"),
                             $wiki_link
                         );
                         $builder->setMainAction(
                             $builder::SEC_SUBMISSION,
                             $button
                         );
                     } else {
                         $link = $f->link()->standard(
                             $lng->txt("exc_view_wiki"),
                             $wiki_link
                         );
                         $builder->addAction(
                             $builder::SEC_SUBMISSION,
                             $link
                         );
                     }
                 }
             }
             // remove invalid resource if no upload yet (see download below)
             /*elseif (substr($selected_wiki["filename"], -1) == "/") {
                 // #16887
                 $submission->deleteResourceObject();
             }*/
         }
         if ($submission->canSubmit()) {
             if (!$valid_wiki && $team_available) {
                 $button = $f->button()->primary(
                     $lng->txt("exc_create_wiki"),
                     $ctrl->getLinkTargetByClass([ilAssignmentPresentationGUI::class, ilExSubmissionGUI::class, self::class], "createWiki")
                 );
                 $builder->setMainAction(
                     $builder::SEC_SUBMISSION,
                     $button
                 );
             }
         }
         if ($submission->hasSubmitted()) {
             $ctrl->setParameterByClass("ilExSubmissionFileGUI", "delivered", $selected_wiki->getId());
             $dl_link = $ctrl->getLinkTargetByClass([
                 ilAssignmentPresentationGUI::class,
                 ilExSubmissionGUI::class,
                 ilExSubmissionFileGUI::class], "download");
             $ctrl->setParameterByClass("ilExSubmissionFileGUI", "delivered", "");
 
             $link = $f->link()->standard(
                 $lng->txt("download"),
                 $dl_link
             );
             $builder->addAction(
                 $builder::SEC_SUBMISSION,
                 $link
             );
         }
     }

Here is the call graph for this function:

◆ createWiki()

ilExAssTypeWikiTeamGUI::createWiki ( )

protected

Create wiki for assignment.

Definition at line 221 of file class.ilExAssTypeWikiTeamGUI.php.

References $access, $lng, ilObject\_exists(), ilRBACAccessHandler\checkAccessOfUser(), ILIAS\Repository\ctrl(), ilExAssWikiTeamAR\getTemplateRefId(), ilLanguage\loadLanguageModule(), and ilLanguage\txt().

                                    : void
     {
         $access = $this->access;
         $lng = $this->lng;
 
         $ar = new ilExAssWikiTeamAR($this->submission->getAssignment()->getId());
         $template_ref_id = $ar->getTemplateRefId();
         $container_ref_id = $ar->getContainerRefId();
 
         // @todo: move checks to central place
         // check if team exists
         $team_members = $this->submission->getTeam()->getMembers();
         $team_available = (sizeof($team_members));
         if (!$team_available) {
             $lng->loadLanguageModule("exc");
             $this->main_tpl->setOnScreenMessage('info', $lng->txt("exc_team_needed_first"), true);
             $this->ctrl->returnToParent($this);
         }
 
         // check if submission is possible
         if (!$this->submission->canSubmit()) {
             $lng->loadLanguageModule("exc");
             $this->main_tpl->setOnScreenMessage('info', $lng->txt("exercise_time_over"), true);
             $this->ctrl->returnToParent($this);
         }
 
         // check create permission of exercise owner
         if (!$access->checkAccessOfUser($this->exercise->getOwner(), "create", "", $container_ref_id, "wiki")) {
             $lng->loadLanguageModule("exc");
             $this->main_tpl->setOnScreenMessage('info', $lng->txt("exc_owner_has_no_permission_to_create_wiki"), true);
             $this->ctrl->returnToParent($this);
         }
 
         if ($template_ref_id > 0 && ilObject::_exists($template_ref_id, true, "wiki")) {
             $template_wiki = new ilObjWiki($template_ref_id);
             $wiki = $template_wiki->cloneObject($container_ref_id);
             $wiki->setTitle($this->exercise->getTitle() . " - " . $this->submission->getAssignment()->getTitle());
         } else {
             $wiki = new ilObjWiki();
             $wiki->setTitle($this->exercise->getTitle() . " - " . $this->submission->getAssignment()->getTitle());
             $wiki->create();
             $wiki->setStartPage($this->submission->getAssignment()->getTitle());
 
             $wiki->createReference();
             $wiki->putInTree($container_ref_id);
             $wiki->setPermissions($container_ref_id);
         }
 
         $wiki->setOwner($this->exercise->getOwner());
         $wiki->setOnline(true);
         $wiki->getObjectProperties()->storePropertyIsOnline(new ilObjectPropertyIsOnline(true));
         $wiki->update();
         $wiki->updateOwner();
 
         $this->submission->deleteAllFiles();
         //$this->handleRemovedUpload();
 
         $this->submission->addResourceObject($wiki->getRefId());
 
         $lng->loadLanguageModule("wiki");
         $this->main_tpl->setOnScreenMessage('success', $lng->txt("wiki_exc_wiki_created"), true);
         $this->ctrl->returnToParent($this);
     }

Here is the call graph for this function:

◆ executeCommand()

ilExAssTypeWikiTeamGUI::executeCommand ( )

Execute command.

Definition at line 53 of file class.ilExAssTypeWikiTeamGUI.php.

References $ctrl, ilCtrl\getCmd(), and ilCtrl\getNextClass().

                                     : void
     {
         $ctrl = $this->ctrl;
 
         $next_class = $ctrl->getNextClass($this);
         $cmd = $ctrl->getCmd();
 
         switch ($next_class) {
             default:
                 if ($cmd === "createWiki") {
                     $this->$cmd();
                 }
         }
     }

Here is the call graph for this function:

◆ getFormValuesArray()

ilExAssTypeWikiTeamGUI::getFormValuesArray ( ilExAssignment $ass )

Get form values array from assignment.

Returns: array

Implements ilExAssignmentTypeGUIInterface.

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

References ilExAssignment\getId(), and ilExAssWikiTeamAR\getTemplateRefId().

                                                            : array
     {
         $values = [];
 
         $ar = new ilExAssWikiTeamAR($ass->getId());
 
         if ($ar->getTemplateRefId() > 0) {
             $values["template_ref_id"] = $ar->getTemplateRefId();
             $values["template"] = "1";
         } else {
             $values["template"] = "0";
         }
         $values["container_ref_id"] = $ar->getContainerRefId();
 
         return $values;
     }

Here is the call graph for this function:

◆ getHTML()

ilExAssTypeWikiTeamGUI::getHTML ( array $par )

Get HTML.

Parameters

array $par parameter

Definition at line 145 of file class.ilExAssTypeWikiTeamGUI.php.

References renderOverviewContent().

                                        : string
     {
         switch ($par["mode"]) {
             case self::MODE_OVERVIEW:
                 $this->renderOverviewContent($par["info"], $par["submission"]);
                 break;
         }
         return "";
     }

Here is the call graph for this function:

◆ getOverviewContent()

ilExAssTypeWikiTeamGUI::getOverviewContent	(	ilInfoScreenGUI	$a_info,
		ilExSubmission	$a_submission
	)

Add overview content of submission to info screen object.

Implements ilExAssignmentTypeGUIInterface.

Definition at line 135 of file class.ilExAssTypeWikiTeamGUI.php.

References ILIAS\Repository\ctrl().

                                                                                              : void
     {
         $this->ctrl->getHTML($this, array("mode" => self::MODE_OVERVIEW, "info" => $a_info, "submission" => $a_submission));
     }

Here is the call graph for this function:

◆ importFormToAssignment()

ilExAssTypeWikiTeamGUI::importFormToAssignment	(	ilExAssignment	$ass,
		ilPropertyFormGUI	$form
	)

Get values from form and put them into assignment.

Implements ilExAssignmentTypeGUIInterface.

Definition at line 103 of file class.ilExAssTypeWikiTeamGUI.php.

References ilExAssignment\getId(), and ilPropertyFormGUI\getInput().

                                                                                         : void
     {
         $ar = new ilExAssWikiTeamAR();
         $ar->setId($ass->getId());
         $ar->setTemplateRefId(0);
         if ($form->getInput("template_ref_id") && $form->getInput("template")) {
             $ar->setTemplateRefId($form->getInput("template_ref_id"));
         }
         $ar->setContainerRefId($form->getInput("container_ref_id"));
         $ar->save();
     }

Here is the call graph for this function:

◆ renderOverviewContent()

ilExAssTypeWikiTeamGUI::renderOverviewContent	(	ilInfoScreenGUI	$a_info,
		ilExSubmission	$a_submission
	)

protected

Render overview content.

Definition at line 158 of file class.ilExAssTypeWikiTeamGUI.php.

References $ctrl, $lng, ilObject\_exists(), ilInfoScreenGUI\addProperty(), ilExSubmission\canSubmit(), ilExSubmission\deleteResourceObject(), ilCtrl\getLinkTargetByClass(), ilExSubmission\getSelectedObject(), ilExSubmission\getTeam(), ilExSubmission\hasSubmitted(), ILIAS\Repository\int(), ilCtrl\setParameterByClass(), and ilLanguage\txt().

Referenced by getHTML().

                                                                                                    : void
     {
         $lng = $this->lng;
         $ctrl = $this->ctrl;
 
         $files_str = "";
         $valid_wiki = false;
 
         $team_members = $a_submission->getTeam()->getMembers();
         $team_available = (count($team_members));
 
         $selected_wiki = $a_submission->getSelectedObject();
         if ($selected_wiki) {
             $wiki_ref_id = (int) $selected_wiki->getTitle();
 
             // #11746
             if (ilObject::_exists($wiki_ref_id, true, "wiki") && $this->tree->isInTree($wiki_ref_id)) {
                 $wiki = new ilObjWiki($wiki_ref_id);
                 if ($wiki->getTitle()) {
                     // #10116 / #12791
                     $ctrl->setParameterByClass("ilobjwikigui", "ref_id", $wiki_ref_id);
                     $wiki_link = ilLink::_getLink($wiki_ref_id);
                     $files_str = '<a href="' . $wiki_link .
                         '">' . $wiki->getTitle() . '</a>';
                     $valid_wiki = true;
                 }
             }
             // remove invalid resource if no upload yet (see download below)
             elseif (substr($selected_wiki["filename"], -1) == "/") {
                 // #16887
                 $a_submission->deleteResourceObject();
             }
         }
         if ($a_submission->canSubmit()) {
             if (!$valid_wiki && $team_available) {
                 $files_str .= $this->gui->button(
                     $lng->txt("exc_create_wiki"),
                     $ctrl->getLinkTargetByClass([ilAssignmentPresentationGUI::class, ilExSubmissionGUI::class, self::class], "createWiki")
                 )->render();
             }
         }
         if ($files_str) {
             $a_info->addProperty($lng->txt("exc_ass_team_wiki"), $files_str);
         }
         if ($a_submission->hasSubmitted()) {
             $ctrl->setParameterByClass("ilExSubmissionFileGUI", "delivered", $selected_wiki->getId());
             $dl_link = $ctrl->getLinkTargetByClass([
                 ilAssignmentPresentationGUI::class,
                 ilExSubmissionGUI::class,
                 ilExSubmissionFileGUI::class], "download");
             $ctrl->setParameterByClass("ilExSubmissionFileGUI", "delivered", "");
 
             $a_info->addProperty($lng->txt("exc_files_returned"), $this->gui->button(
                 $lng->txt("download"),
                 $dl_link
             )->render());
         }
     }