Add user to group from awareness tool. More...

Collaboration diagram for ilGroupAddToGroupActionGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	show ()

	sendResponse (string $a_content)

	selectGroup ()

	confirmAddUser ()

	addUser ()

	selectParent ()

	createGroup ($form=null)

	confirmCreateGroupAndAddUser ()

	createGroupAndAddUser ()

Protected Member Functions
	initGroupRefIdFromQuery ()

	initGroupParentRefIdFromQuery ()

	initUserIdFromQuery ()

	getGroupCreationForm ()

Protected Attributes
ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

UIServices	$ui

ilLanguage	$lng

ilTree	$tree

ilObjUser	$user

GlobalHttpState	$http

Factory	$refinery

Detailed Description

Add user to group from awareness tool.

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

Definition at line 17 of file class.ilGroupAddToGroupActionGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilGroupAddToGroupActionGUI::__construct ( )

Definition at line 32 of file class.ilGroupAddToGroupActionGUI.php.

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->ui = $DIC->ui();
        $this->lng = $DIC->language();
        $this->tree = $DIC->repositoryTree();
        $this->user = $DIC->user();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
 
 
        $this->lng->loadLanguageModule("grp");
        $this->ctrl->saveParameter($this, array("user_id", "modal_exists"));
    }

References $DIC, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ addUser()

ilGroupAddToGroupActionGUI::addUser ( )

Definition at line 238 of file class.ilGroupAddToGroupActionGUI.php.

                             : void
    {
        $lng = $this->lng;
 
        $ref_id = $this->initGroupRefIdFromQuery();
        $user_id = $this->initUserIdFromQuery();
 
        // @todo: check permission
 
        $group = new ilObjGroup($ref_id);
        $participants = ilParticipants::getInstanceByObjId($group->getId());
 
        $participants->add($user_id, ilParticipants::IL_GRP_MEMBER);
 
        $participants->sendNotification(
            ilGroupMembershipMailNotification::TYPE_ADMISSION_MEMBER,
            $user_id
        );
 
        echo ilUtil::getSystemMessageHTML($lng->txt("grp_user_been_added"), "success");
        echo "<script>setTimeout(function (){ il.Group.UserActions.closeModal();}, 1000);</script>";
        exit;
    }

References $lng, $ref_id, exit, ilParticipants\getInstanceByObjId(), ilUtil\getSystemMessageHTML(), ilParticipants\IL_GRP_MEMBER, initGroupRefIdFromQuery(), initUserIdFromQuery(), ilLanguage\txt(), and ilGroupMembershipMailNotification\TYPE_ADMISSION_MEMBER.

Here is the call graph for this function:

◆ confirmAddUser()

ilGroupAddToGroupActionGUI::confirmAddUser ( )

Definition at line 198 of file class.ilGroupAddToGroupActionGUI.php.

                                    : void
    {
        $ctrl = $this->ctrl;
        $lng = $this->lng;
 
        $ref_id = $this->initGroupRefIdFromQuery();
        $user_id = $this->initUserIdFromQuery();
        $participants = ilParticipants::getInstanceByObjId(ilObject::_lookupObjId($ref_id));
        if ($participants->isMember($user_id)) {
            $url = $ctrl->getLinkTarget($this, "selectGroup", "", true);
            $button = $this->ui->factory()->button()->standard($lng->txt("back"), "#")
                ->withOnLoadCode(function ($id) use ($url) {
                    return "$('#$id').on('click', function() {il.Util.ajaxReplaceInner('$url', 'il_grp_action_modal_content'); return false;})";
                });
 
            echo
                ilUtil::getSystemMessageHTML($lng->txt("grp_user_already_in_group") . "<br>" .
                    $lng->txt("obj_user") . ": " . ilUserUtil::getNamePresentation($user_id) . "<br>" .
                    $lng->txt("obj_grp") . ": " . ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id)), "failure") .
                $this->ui->renderer()->renderAsync($button);
            exit;
        }
 
 
        // button create new group
        $ctrl->setParameter($this, "grp_act_ref_id", $ref_id);
        $url = $ctrl->getLinkTarget($this, "addUser", "", true);
        $button = $this->ui->factory()->button()->standard($lng->txt("grp_add_user"), "#")
            ->withOnLoadCode(function ($id) use ($url) {
                return "$('#$id').on('click', function() {il.Util.ajaxReplaceInner('$url', 'il_grp_action_modal_content'); return false;})";
            });
 
        echo
            ilUtil::getSystemMessageHTML($lng->txt("grp_sure_add_user_to_group") . "<br>" .
                $lng->txt("obj_user") . ": " . ilUserUtil::getNamePresentation($user_id) . "<br>" .
                $lng->txt("obj_grp") . ": " . ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id)), "question") .
            $this->ui->renderer()->renderAsync($button);
        exit;
    }

References $ctrl, $id, $lng, $ref_id, $url, ilObject\_lookupObjId(), ilObject\_lookupTitle(), exit, ilParticipants\getInstanceByObjId(), ilCtrl\getLinkTarget(), ilUserUtil\getNamePresentation(), ilUtil\getSystemMessageHTML(), initGroupRefIdFromQuery(), initUserIdFromQuery(), ilCtrl\setParameter(), ilLanguage\txt(), and ILIAS\Repository\ui().

Here is the call graph for this function:

◆ confirmCreateGroupAndAddUser()

ilGroupAddToGroupActionGUI::confirmCreateGroupAndAddUser ( )

Definition at line 313 of file class.ilGroupAddToGroupActionGUI.php.

                                                  : void
    {
        $lng = $this->lng;
 
        $user_id = $this->initUserIdFromQuery();
        $title = '';
        if ($this->http->wrapper()->post()->has('title')) {
            $title = $this->http->wrapper()->post()->retrieve(
                'title',
                $this->refinery->kindlyTo()->string()
            );
        }
        $form = $this->getGroupCreationForm();
 
 
 
        if (!$form->checkInput()) {
            $this->createGroup($form);
            return;
        }
 
        $this->ctrl->saveParameter($this, "grp_act_par_ref_id");
        $form->setFormAction($this->ctrl->getLinkTarget($this, "createGroupAndAddUser", "", true));
        $form->setValuesByPost();
 
        $button = $this->ui->factory()->button()->standard($lng->txt("grp_create_and_add_user"), "#")
            ->withOnLoadCode(function ($id) {
                return "$('#$id').on('click', function(e) {il.Group.UserActions.createGroup(e);})";
            });
 
        echo
            ilUtil::getSystemMessageHTML($lng->txt("grp_sure_create_group_add_user") . "<br>" .
                $lng->txt("obj_user") . ": " . ilUserUtil::getNamePresentation($user_id) . "<br>" .
                $lng->txt("obj_grp") . ": " . $title, "question") .
            "<div class='ilNoDisplay'>" . $form->getHTML() . "</div>" .
            "<div class='ilRight'>" . $this->ui->renderer()->renderAsync($button) . "</div>";
 
        exit;
    }

References $id, $lng, createGroup(), ILIAS\Repository\ctrl(), exit, getGroupCreationForm(), ilUserUtil\getNamePresentation(), ilUtil\getSystemMessageHTML(), ILIAS\FileDelivery\http(), initUserIdFromQuery(), ILIAS\Repository\refinery(), ilLanguage\txt(), and ILIAS\Repository\ui().

Here is the call graph for this function:

◆ createGroup()

ilGroupAddToGroupActionGUI::createGroup ( $form = null )

Definition at line 280 of file class.ilGroupAddToGroupActionGUI.php.

                                             : void
    {
        $lng = $this->lng;
 
        $ref_id = $this->initGroupParentRefIdFromQuery();
 
        if ($form == null) {
            $form = $this->getGroupCreationForm();
        }
        $this->ctrl->saveParameter($this, "grp_act_par_ref_id");
        $form->setFormAction($this->ctrl->getLinkTarget($this, "confirmCreateGroupAndAddUser", "", true));
 
        echo ilUtil::getSystemMessageHTML(str_replace("%1", ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id)), $lng->txt("grp_create_new_grp_in")), "info") .
            $form->getHTML();
        exit;
    }

References $lng, $ref_id, ilObject\_lookupObjId(), ilObject\_lookupTitle(), ILIAS\Repository\ctrl(), exit, getGroupCreationForm(), ilUtil\getSystemMessageHTML(), initGroupParentRefIdFromQuery(), and ilLanguage\txt().

Referenced by confirmCreateGroupAndAddUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createGroupAndAddUser()

ilGroupAddToGroupActionGUI::createGroupAndAddUser ( )

Definition at line 353 of file class.ilGroupAddToGroupActionGUI.php.

                                           : void
    {
        $lng = $this->lng;
 
        $user_id = $this->initUserIdFromQuery();
        $ref_id = $this->initGroupParentRefIdFromQuery();
        $form = $this->getGroupCreationForm();
 
        $form->checkInput();
 
        $group_gui = new ilObjGroupGUI("", 0, true);
 
        // create instance
        $newObj = new ilObjGroup();
        $newObj->setType("grp");
        $newObj->setTitle($form->getInput("title"));
        $newObj->setDescription($form->getInput("desc"));
        $newObj->create();
 
        $group_gui->putObjectInTree($newObj, $ref_id);
 
        // apply didactic template?
        $dtpl = $group_gui->getDidacticTemplateVar("dtpl");
        if ($dtpl) {
            $newObj->applyDidacticTemplate($dtpl);
        }
 
        $group_gui->afterSave($newObj, false);
 
 
        $participants = ilParticipants::getInstanceByObjId($newObj->getId());
 
        $participants->add($user_id, ilParticipants::IL_GRP_MEMBER);
 
        $participants->sendNotification(
            ilGroupMembershipMailNotification::TYPE_ADMISSION_MEMBER,
            $user_id
        );
 
 
        $url = ilLink::_getLink($newObj->getRefId());
        echo ilUtil::getSystemMessageHTML($lng->txt("grp_created_and_user_been_added"), "success");
        echo "<script>setTimeout(function (){ window.location.replace('$url');}, 1500);</script>";
        exit;
    }

References $lng, $ref_id, $url, ilLink\_getLink(), exit, getGroupCreationForm(), ilParticipants\getInstanceByObjId(), ilUtil\getSystemMessageHTML(), ilParticipants\IL_GRP_MEMBER, initGroupParentRefIdFromQuery(), initUserIdFromQuery(), ilLanguage\txt(), and ilGroupMembershipMailNotification\TYPE_ADMISSION_MEMBER.

Here is the call graph for this function:

◆ executeCommand()

ilGroupAddToGroupActionGUI::executeCommand ( )

Definition at line 86 of file class.ilGroupAddToGroupActionGUI.php.

                                    : void
    {
        $ctrl = $this->ctrl;
        $user = $this->user;
 
        $next_class = $ctrl->getNextClass($this);
        $cmd = $ctrl->getCmd("show");
 
        if ($cmd == "show") {
            $ca = ilGroupUserActionProvider::getCommandAccess($user->getId());
            if (count($ca) == 0) {
                return;
            }
            if (count($ca) == 1) {
                switch (current($ca)) {
                    case "create_grp":
                        $cmd = "selectParent";
                        break;
 
                    case "manage_members":
                        $cmd = "selectGroup";
                        break;
 
                    default:
                        return;
                }
            }
        }
 
        switch ($next_class) {
            default:
                if (in_array($cmd, array("show", "selectGroup", "confirmAddUser", "addUser",
                    "selectParent", "createGroup", "confirmCreateGroupAndAddUser", "createGroupAndAddUser"))) {
                    $ctrl->setParameter($this, "modal_exists", 1);
                    $this->$cmd();
                }
        }
    }

References $ctrl, $user, ilCtrl\getCmd(), ilGroupUserActionProvider\getCommandAccess(), ilObject\getId(), ilCtrl\getNextClass(), and ilCtrl\setParameter().

Here is the call graph for this function:

◆ getGroupCreationForm()

ilGroupAddToGroupActionGUI::getGroupCreationForm ( )

protected

Definition at line 298 of file class.ilGroupAddToGroupActionGUI.php.

                                             : ilPropertyFormGUI
    {
        $lng = $this->lng;
 
        $ref_id = $this->initGroupRefIdFromQuery();
 
        $group_gui = new ilObjGroupGUI("", 0, true);
        $group_gui->setCreationMode();
        $form = $group_gui->initForm("create", true);
        $form->clearCommandButtons();
        $form->addCommandButton("save", $lng->txt("grp_next"));
        $form->setShowTopButtons(false);
        return $form;
    }

References $lng, $ref_id, initGroupRefIdFromQuery(), and ilLanguage\txt().

Referenced by confirmCreateGroupAndAddUser(), createGroup(), and createGroupAndAddUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initGroupParentRefIdFromQuery()

ilGroupAddToGroupActionGUI::initGroupParentRefIdFromQuery ( )

protected

Definition at line 62 of file class.ilGroupAddToGroupActionGUI.php.

                                                      : int
    {
        $ref_id = 0;
        if ($this->http->wrapper()->query()->has('grp_act_par_ref_id')) {
            $ref_id = $this->http->wrapper()->query()->retrieve(
                'grp_act_par_ref_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        return $ref_id;
    }

References $ref_id, ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by createGroup(), and createGroupAndAddUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initGroupRefIdFromQuery()

ilGroupAddToGroupActionGUI::initGroupRefIdFromQuery ( )

protected

Definition at line 50 of file class.ilGroupAddToGroupActionGUI.php.

                                                : int
    {
        $ref_id = 0;
        if ($this->http->wrapper()->query()->has('grp_act_ref_id')) {
            $ref_id = $this->http->wrapper()->query()->retrieve(
                'grp_act_ref_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        return $ref_id;
    }

References $ref_id, ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by addUser(), confirmAddUser(), and getGroupCreationForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initUserIdFromQuery()

ilGroupAddToGroupActionGUI::initUserIdFromQuery ( )

protected

Definition at line 74 of file class.ilGroupAddToGroupActionGUI.php.

                                            : int
    {
        $user_id = 0;
        if ($this->http->wrapper()->query()->has('user_id')) {
            $user_id = $this->http->wrapper()->query()->retrieve(
                'user_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        return $user_id;
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by addUser(), confirmAddUser(), confirmCreateGroupAndAddUser(), and createGroupAndAddUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ selectGroup()

ilGroupAddToGroupActionGUI::selectGroup ( )

Definition at line 182 of file class.ilGroupAddToGroupActionGUI.php.

                                 : void
    {
        $tree = $this->tree;
 
        $exp = new ilGroupActionTargetExplorerGUI($this, "selectGroup");
 
        $exp->setClickableType("grp");
        $exp->setTypeWhiteList(array("root", "cat", "crs", "fold", "grp"));
        $exp->setPathOpen($tree->readRootId());
 
        if (!$exp->handleCommand()) {
            $this->sendResponse($exp->getHTML());
        }
        exit;
    }

References $tree, exit, ilTree\readRootId(), and sendResponse().

Here is the call graph for this function:

◆ selectParent()

ilGroupAddToGroupActionGUI::selectParent ( )

Definition at line 262 of file class.ilGroupAddToGroupActionGUI.php.

                                  : void
    {
        $tree = $this->tree;
        $lng = $this->lng;
 
        $exp = new ilGroupActionTargetExplorerGUI($this, "selectParent", true);
 
        $exp->setTypeWhiteList(array("root", "cat", "crs"));
        $exp->setPathOpen($tree->readRootId());
 
        if (!$exp->handleCommand()) {
            $this->sendResponse(ilUtil::getSystemMessageHTML($lng->txt("grp_no_perm_to_add_create_first")) .
                $exp->getHTML());
        }
 
        exit;
    }

References $lng, $tree, exit, ilUtil\getSystemMessageHTML(), ilTree\readRootId(), sendResponse(), and ilLanguage\txt().

Here is the call graph for this function:

◆ sendResponse()

ilGroupAddToGroupActionGUI::sendResponse ( string $a_content )

Definition at line 153 of file class.ilGroupAddToGroupActionGUI.php.

                                                   : void
    {
        $lng = $this->lng;
 
        $modal_exists = false;
        if ($this->http->wrapper()->query()->has('modal_exists')) {
            $modal_exists = (bool) $this->http->wrapper()->query()->retrieve(
                'modal_exists',
                $this->refinery->kindlyTo()->int()
            );
        }
        if ($modal_exists) {
            echo $this->ui->renderer()->renderAsync($this->ui->factory()->legacy($a_content));
        } else {
            $mtpl = new ilTemplate("tpl.grp_add_to_grp_modal_content.html", true, true, "./Modules/Group/UserActions");
            $mtpl->setVariable("CONTENT", $a_content);
            $content = $this->ui->factory()->legacy($mtpl->get());
            $modal = $this->ui->factory()->modal()->roundtrip(
                $lng->txt("grp_add_user_to_group"),
                $content
            )->withOnLoadCode(function ($id) {
                return "il.UI.modal.showModal('$id', {'ajaxRenderUrl':'','keyboard':true}, {id: '$id'});";
            });
            echo $this->ui->renderer()->renderAsync($modal);
        }
        exit;
    }

References $id, $lng, exit, ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), ilLanguage\txt(), and ILIAS\Repository\ui().

Referenced by selectGroup(), selectParent(), and show().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ show()

ilGroupAddToGroupActionGUI::show ( )

Definition at line 124 of file class.ilGroupAddToGroupActionGUI.php.

                          : void
    {
        $lng = $this->lng;
        $ctrl = $this->ctrl;
 
        $toolbar = new ilToolbarGUI();
 
        // button use existing group
        $url1 = $ctrl->getLinkTarget($this, "selectGroup", "", true);
        $button1 = $this->ui->factory()->button()->standard($lng->txt("grp_use_existing"), "#")
            ->withOnLoadCode(function ($id) use ($url1) {
                return "$('#$id').on('click', function() {il.Util.ajaxReplaceInner('$url1', 'il_grp_action_modal_content'); return false;})";
            });
        $toolbar->addComponent($button1);
 
        // button create new group
        $url2 = $ctrl->getLinkTarget($this, "selectParent", "", true);
        $button2 = $this->ui->factory()->button()->standard($lng->txt("grp_create_new"), "#")
            ->withOnLoadCode(function ($id) use ($url2) {
                return "$('#$id').on('click', function() {il.Util.ajaxReplaceInner('$url2', 'il_grp_action_modal_content'); return false;})";
            });
        $toolbar->addComponent($button2);
 
        $this->sendResponse(
            ilUtil::getSystemMessageHTML($lng->txt("grp_create_or_use_existing"), "question") .
            $toolbar->getHTML()
        );
    }