ilExAssTypeWikiTeamGUI Class Reference

Team wiki type gui implementations. More...

Inheritance diagram for ilExAssTypeWikiTeamGUI:

Collaboration diagram for ilExAssTypeWikiTeamGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	executeCommand ()
	Execute command. More...
	addEditFormCustomProperties (ilPropertyFormGUI $form)
	Add custom form properties to edit form. Parameters ilPropertyFormGUI $form More...
	importFormToAssignment (ilExAssignment $ass, ilPropertyFormGUI $form)
	Get values from form and put them into assignment. Parameters ilExAssignment $ass ilPropertyFormGUI $form More...
	getFormValuesArray (ilExAssignment $ass)
	Get form values array from assignment. Parameters ilExAssignment $ass Returns array More...
	getOverviewContent (ilInfoScreenGUI $a_info, ilExSubmission $a_submission)
	Add overview content of submission to info screen object. Parameters ilInfoScreenGUI $a_info ilExSubmission $a_submission More...
	getHTML ($par)
	Get HTML. More...
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
	$lng
	$ctrl
	$tree
	$access

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 11 of file class.ilExAssTypeWikiTeamGUI.php.

Constructor & Destructor Documentation

__construct()

ilExAssTypeWikiTeamGUI::__construct

(

)

Constructor.

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

References $DIC.

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->tree = $DIC->repositoryTree();
        $this->access = $DIC->access();
    }

Member Function Documentation

addEditFormCustomProperties()

ilExAssTypeWikiTeamGUI::addEditFormCustomProperties

(

ilPropertyFormGUI

$form

)

Add custom form properties to edit form.

Parameters

ilPropertyFormGUI

$form

Implements ilExAssignmentTypeGUIInterface.

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

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

    {
        $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:

createWiki()

ilExAssTypeWikiTeamGUI::createWiki ( )

protected

Create wiki for assignment.

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

References $access, $lng, ilObject\_exists(), ilExAssWikiTeamAR\getTemplateRefId(), and ilUtil\sendInfo().

    {
        $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");
            ilUtil::sendInfo($lng->txt("exc_team_needed_first"), true);
            $this->ctrl->returnToParent($this);
        }

        // check if submission is possible
        if (!$this->submission->canSubmit()) {
            $lng->loadLanguageModule("exc");
            ilUtil::sendInfo($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");
            ilUtil::sendInfo($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->update();
        $wiki->updateOwner();

        $this->submission->deleteAllFiles();
        //$this->handleRemovedUpload();

        $this->submission->addResourceObject($wiki->getRefId());

        $lng->loadLanguageModule("wiki");
        ilUtil::sendSuccess($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.

    {
        $ctrl = $this->ctrl;

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

        switch ($next_class) {
            default:
                if (in_array($cmd, array("createWiki"))) {
                    $this->$cmd();
                }
        }
    }

getFormValuesArray()

ilExAssTypeWikiTeamGUI::getFormValuesArray

(

ilExAssignment

$ass

)

Get form values array from assignment.

Parameters

ilExAssignment

$ass

Returns

array

Implements ilExAssignmentTypeGUIInterface.

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

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

    {
        $values = [];

        $ar = new ilExAssWikiTeamAR($ass->getId());

        if ($ar->getTemplateRefId() > 0) {
            $values["template_ref_id"] = $ar->getTemplateRefId();
            $values["template"] = 1;
        }
        $values["container_ref_id"] = $ar->getContainerRefId();

        return $values;
    }

Here is the call graph for this function:

getHTML()

ilExAssTypeWikiTeamGUI::getHTML

(

$par

)

Get HTML.

Parameters

array

$par

parameter

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

References renderOverviewContent().

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

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.

Parameters

ilInfoScreenGUI	$a_info
ilExSubmission	$a_submission

Implements ilExAssignmentTypeGUIInterface.

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

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

importFormToAssignment()

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

Get values from form and put them into assignment.

Parameters

ilExAssignment	$ass
ilPropertyFormGUI	$form

Implements ilExAssignmentTypeGUIInterface.

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

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

    {
        $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.

Parameters

ilInfoScreenGUI	$a_info
ilExSubmission	$a_submission

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

References $ctrl, $lng, ilObject\_exists(), ilLink\_getLink(), ilInfoScreenGUI\addProperty(), ilExSubmission\canSubmit(), ilExSubmission\deleteResourceObject(), ilLinkButton\getInstance(), ilExSubmission\getSelectedObject(), ilExSubmission\getTeam(), and ilExSubmission\hasSubmitted().

Referenced by getHTML().

    {
        $lng = $this->lng;
        $ctrl = $this->ctrl;

        $files_str = "";
        $valid_wiki = false;

        $team_members = $a_submission->getTeam()->getMembers();
        $team_available = (sizeof($team_members));

        $selected_wiki = $a_submission->getSelectedObject();
        if ($selected_wiki) {
            $wiki_ref_id = (int) $selected_wiki["filetitle"];

            // #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($selected_wiki["returned_id"]);
            }
        }
        if ($a_submission->canSubmit()) {
            if (!$valid_wiki && $team_available) {
                $button = ilLinkButton::getInstance();
                $button->setCaption("exc_create_wiki");
                $button->setUrl($ctrl->getLinkTarget($this, "createWiki"));

                $files_str .= "" . $button->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["returned_id"]);
            $dl_link = $ctrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExSubmissionFileGUI"), "download");
            $ctrl->setParameterByClass("ilExSubmissionFileGUI", "delivered", "");

            $button = ilLinkButton::getInstance();
            $button->setCaption("download");
            $button->setUrl($dl_link);

            $a_info->addProperty($lng->txt("exc_files_returned"), $button->render());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilExAssTypeWikiTeamGUI::$access

protected

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

Referenced by createWiki().

$ctrl

ilExAssTypeWikiTeamGUI::$ctrl

protected

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

Referenced by executeCommand(), and renderOverviewContent().

$lng

ilExAssTypeWikiTeamGUI::$lng

protected

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

Referenced by addEditFormCustomProperties(), createWiki(), and renderOverviewContent().

$tree

ilExAssTypeWikiTeamGUI::$tree

protected

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

MODE_OVERVIEW

const ilExAssTypeWikiTeamGUI::MODE_OVERVIEW = "overview"

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

---

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

• Modules/Exercise/AssignmentTypes/GUI/classes/class.ilExAssTypeWikiTeamGUI.php