ilMailingListsGUI Class Reference

Collaboration diagram for ilMailingListsGUI:

Public Member Functions
	__construct ()
	executeCommand ()
	confirmDelete ()
	performDelete ()
	mailToList ()
	showMailingLists ()
	cancel ()
	saveForm ()
	showForm ()
	showMembersList ()
	confirmDeleteMembers ()
	performDeleteMembers ()
	saveAssignmentForm ()
	showAssignmentForm (?ilPropertyFormGUI $form=null)

Private Member Functions
	getMailingListIdsFromRequest ()
	initForm (string $a_type='create')
	setValuesByObject ()
	setDefaultValues ()

Private Attributes
ILIAS HTTP GlobalHttpState	$http
Refinery	$refinery
ilGlobalTemplateInterface	$tpl
ilCtrlInterface	$ctrl
ilLanguage	$lng
ilObjUser	$user
ilErrorHandling	$error
ilToolbarGUI	$toolbar
ilRbacSystem	$rbacsystem
ilFormatMail	$umail
ilMailingLists	$mlists
ilPropertyFormGUI	$form_gui

Detailed Description

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

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

Constructor & Destructor Documentation

__construct()

ilMailingListsGUI::__construct

(

)

Definition at line 42 of file class.ilMailingListsGUI.php.

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

    {
        global $DIC;

        $this->tpl = $DIC->ui()->mainTemplate();
        $this->ctrl = $DIC['ilCtrl'];
        $this->lng = $DIC['lng'];
        $this->rbacsystem = $DIC['rbacsystem'];
        $this->user = $DIC['ilUser'];
        $this->error = $DIC['ilErr'];
        $this->toolbar = $DIC['ilToolbar'];
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();

        $this->umail = new ilFormatMail($this->user->getId());
        $this->mlists = new ilMailingLists($this->user);
        $this->mlists->setCurrentMailingList(
            $this->http->wrapper()->query()->has('ml_id')
                ? $this->http->wrapper()->query()->retrieve('ml_id', $this->refinery->kindlyTo()->int())
                : 0
        );

        $this->ctrl->saveParameter($this, 'mobj_id');
        $this->ctrl->saveParameter($this, 'ref');
    }

Here is the call graph for this function:

Member Function Documentation

cancel()

ilMailingListsGUI::cancel

(

)

Definition at line 315 of file class.ilMailingListsGUI.php.

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

                            : void
    {
        if (
            $this->http->wrapper()->query()->has('ref') &&
            $this->http->wrapper()->query()->retrieve('ref', $this->refinery->kindlyTo()->string()) === 'mail') {
            $this->ctrl->returnToParent($this);
        }

        $this->showMailingLists();
    }

Here is the call graph for this function:

confirmDelete()

ilMailingListsGUI::confirmDelete

(

)

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

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

                                   : bool
    {
        $ml_ids = $this->getMailingListIdsFromRequest();
        if ($ml_ids === []) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_select_one_entry'));
            $this->showMailingLists();
            return true;
        }

        $c_gui = new ilConfirmationGUI();

        $c_gui->setFormAction($this->ctrl->getFormAction($this, 'performDelete'));
        $c_gui->setHeaderText($this->lng->txt('mail_sure_delete_entry'));
        $c_gui->setCancel($this->lng->txt('cancel'), 'showMailingLists');
        $c_gui->setConfirm($this->lng->txt('confirm'), 'performDelete');

        $entries = $this->mlists->getSelected($ml_ids);
        foreach ($entries as $entry) {
            $c_gui->addItem('ml_id[]', (string) $entry->getId(), $entry->getTitle());
        }

        $this->tpl->setTitle($this->lng->txt('mail_addressbook'));
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.mail_mailing_lists_list.html', 'Services/Contact');
        $this->tpl->setVariable('DELETE_CONFIRMATION', $c_gui->getHTML());

        $this->tpl->printToStdout();

        return true;
    }

Here is the call graph for this function:

confirmDeleteMembers()

ilMailingListsGUI::confirmDeleteMembers

(

)

Definition at line 501 of file class.ilMailingListsGUI.php.

References ILIAS\Repository\ctrl(), ilUserUtil\getNamePresentation(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and showMembersList().

                                          : bool
    {
        if (!$this->http->wrapper()->post()->has('a_id')) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_select_one_entry'));
            $this->showMembersList();
            return true;
        }

        $c_gui = new ilConfirmationGUI();
        $this->ctrl->setParameter($this, 'ml_id', $this->mlists->getCurrentMailingList()->getId());
        $c_gui->setFormAction($this->ctrl->getFormAction($this, 'performDeleteMembers'));
        $c_gui->setHeaderText($this->lng->txt('mail_sure_delete_entry'));
        $c_gui->setCancel($this->lng->txt('cancel'), 'showMembersList');
        $c_gui->setConfirm($this->lng->txt('confirm'), 'performDeleteMembers');

        $assigned_entries = $this->mlists->getCurrentMailingList()->getAssignedEntries();

        $usr_ids = [];
        foreach ($assigned_entries as $entry) {
            $usr_ids[] = $entry['usr_id'];
        }

        $names = ilUserUtil::getNamePresentation($usr_ids, false, false, '', false, false, false);

        $requested_entry_ids = $this->http->wrapper()->post()->retrieve(
            'a_id',
            $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
        );

        foreach ($assigned_entries as $entry) {
            if (in_array($entry['a_id'], $requested_entry_ids, true)) {
                $c_gui->addItem('a_id[]', (string) $entry['a_id'], $names[$entry['usr_id']]);
            }
        }

        $this->tpl->setTitle($this->lng->txt('mail_addressbook'));
        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.mail_mailing_lists_members.html',
            'Services/Contact'
        );
        $this->tpl->setVariable('DELETE_CONFIRMATION', $c_gui->getHTML());

        $this->tpl->printToStdout();
        return true;
    }

Here is the call graph for this function:

executeCommand()

ilMailingListsGUI::executeCommand

(

)

Definition at line 68 of file class.ilMailingListsGUI.php.

References ILIAS\Repository\ctrl(), ilBuddySystem\getInstance(), ilBuddyList\getInstanceByGlobalUser(), and ILIAS\Repository\lng().

                                    : bool
    {
        if (
            !ilBuddySystem::getInstance()->isEnabled() ||
            (
                0 === count(ilBuddyList::getInstanceByGlobalUser()->getLinkedRelations()) &&
                !$this->mlists->hasAny()
            )
        ) {
            $this->error->raiseError($this->lng->txt('msg_no_perm_read'), $this->error->MESSAGE);
        }

        $forward_class = $this->ctrl->getNextClass($this);

        switch ($forward_class) {
            default:
                if (!($cmd = $this->ctrl->getCmd())) {
                    $cmd = 'showMailingLists';
                }

                $this->$cmd();
                break;
        }


        return true;
    }

Here is the call graph for this function:

getMailingListIdsFromRequest()

ilMailingListsGUI::getMailingListIdsFromRequest ( )

private

Returns

int[]

Definition at line 99 of file class.ilMailingListsGUI.php.

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

Referenced by confirmDelete(), and mailToList().

                                                   : array
    {
        $ml_ids = [];
        if ($this->http->wrapper()->query()->has('ml_id')) {
            $ml_ids = [
                $this->http->wrapper()->query()->retrieve('ml_id', $this->refinery->kindlyTo()->int())
            ];
        } elseif ($this->http->wrapper()->post()->has('ml_id')) {
            $ml_ids = $this->http->wrapper()->post()->retrieve(
                'ml_id',
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }

        return array_filter($ml_ids);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilMailingListsGUI::initForm ( string  $a_type = 'create' )

private

Definition at line 367 of file class.ilMailingListsGUI.php.

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

Referenced by saveForm(), and showForm().

                                                        : void
    {
        $this->form_gui = new ilPropertyFormGUI();

        $this->form_gui->setFormAction($this->ctrl->getFormAction($this, 'saveForm'));
        $this->form_gui->setTitle($this->lng->txt('mail_mailing_list'));

        $titleGui = new ilTextInputGUI($this->lng->txt('title'), 'title');
        $titleGui->setRequired(true);
        $this->form_gui->addItem($titleGui);

        $descriptionGui = new ilTextAreaInputGUI($this->lng->txt('description'), 'description');
        $descriptionGui->setCols(40);
        $descriptionGui->setRows(8);
        $this->form_gui->addItem($descriptionGui);

        $this->form_gui->addCommandButton('saveForm', $this->lng->txt('save'));
        $this->form_gui->addCommandButton('showMailingLists', $this->lng->txt('cancel'));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

mailToList()

ilMailingListsGUI::mailToList

(

)

Definition at line 180 of file class.ilMailingListsGUI.php.

References $id, getMailingListIdsFromRequest(), ILIAS\Repository\lng(), ilUtil\redirect(), showMailingLists(), and ILIAS\Repository\user().

                                : bool
    {
        // check if current user may send mails
        $mail = new ilMail($this->user->getId());
        $mailing_allowed = $this->rbacsystem->checkAccess('internal_mail', $mail->getMailObjectReferenceId());

        if (!$mailing_allowed) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_permission'));
            return true;
        }

        $ml_ids = $this->getMailingListIdsFromRequest();
        if ($ml_ids === []) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_select_one_entry'));
            $this->showMailingLists();
            return true;
        }

        $mail_data = $this->umail->retrieveFromStage();
        $lists = [];
        foreach ($ml_ids as $id) {
            if ($this->mlists->isOwner($id, $this->user->getId()) &&
                !$this->umail->existsRecipient('#il_ml_' . $id, (string) $mail_data['rcp_to'])) {
                $lists['#il_ml_' . $id] = '#il_ml_' . $id;
            }
        }

        if (count($lists)) {
            $mail_data = $this->umail->appendSearchResult(array_values($lists), 'to');
            $this->umail->persistToStage(
                (int) $mail_data['user_id'],
                $mail_data['attachments'],
                $mail_data['rcp_to'],
                $mail_data['rcp_cc'],
                $mail_data['rcp_bcc'],
                $mail_data['m_subject'],
                $mail_data['m_message'],
                $mail_data['use_placeholders'],
                $mail_data['tpl_ctx_id'],
                $mail_data['tpl_ctx_params']
            );
        }

        ilUtil::redirect("ilias.php?baseClass=ilMailGUI&type=search_res");

        return true;
    }

Here is the call graph for this function:

performDelete()

ilMailingListsGUI::performDelete

(

)

Definition at line 148 of file class.ilMailingListsGUI.php.

References $id, ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and showMailingLists().

                                   : bool
    {
        if ($this->http->wrapper()->post()->has('ml_id')) {
            $ml_ids = array_filter(
                $this->http->wrapper()->post()->retrieve(
                    'ml_id',
                    $this->refinery->kindlyTo()->listOf(
                        $this->refinery->kindlyTo()->int()
                    )
                )
            );

            $counter = 0;
            foreach ($ml_ids as $id) {
                if ($this->mlists->isOwner($id, $this->user->getId())) {
                    $this->mlists->get($id)->delete();
                    ++$counter;
                }
            }

            if ($counter) {
                $this->tpl->setOnScreenMessage('success', $this->lng->txt('mail_deleted_entry'));
            }
        } else {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('mail_delete_error'));
        }

        $this->showMailingLists();

        return true;
    }

Here is the call graph for this function:

performDeleteMembers()

ilMailingListsGUI::performDeleteMembers

(

)

Definition at line 549 of file class.ilMailingListsGUI.php.

References $id, ILIAS\Repository\ctrl(), ilBuddyList\getInstanceByGlobalUser(), ilUserUtil\getNamePresentation(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), showMembersList(), and ILIAS\Repository\user().

                                          : bool
    {
        if (!$this->mlists->isOwner($this->mlists->getCurrentMailingList()->getId(), $this->user->getId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        if (
            $this->http->wrapper()->post()->has('a_id') &&
            ($requested_entry_ids = $this->http->wrapper()->post()->retrieve(
                'a_id',
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
            )) !== []
        ) {
            $assigned_entries = $this->mlists->getCurrentMailingList()->getAssignedEntries();
            foreach ($requested_entry_ids as $id) {
                if (isset($assigned_entries[$id])) {
                    $this->mlists->getCurrentMailingList()->deleteEntry($id);
                }
            }
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('mail_deleted_entry'));
        } else {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('mail_delete_error'));
        }

        $this->showMembersList();

        return true;
    }

Here is the call graph for this function:

saveAssignmentForm()

ilMailingListsGUI::saveAssignmentForm

(

)

Definition at line 633 of file class.ilMailingListsGUI.php.

References ilBuddyList\getInstanceByGlobalUser(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), showAssignmentForm(), showMembersList(), and ILIAS\Repository\user().

                                        : bool
    {
        if (!$this->mlists->isOwner($this->mlists->getCurrentMailingList()->getId(), $this->user->getId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $form = $this->getAssignmentForm();
        if (!$form->checkInput()) {
            $form->setValuesByPost();
            $this->showAssignmentForm($form);
            return true;
        }

        if (
            ilBuddyList::getInstanceByGlobalUser()->getRelationByUserId(
                $this->http->wrapper()->post()->retrieve('usr_id', $this->refinery->kindlyTo()->int())
            )->isLinked()
        ) {
            $this->mlists->getCurrentMailingList()->assignUser(
                $this->http->wrapper()->post()->retrieve('usr_id', $this->refinery->kindlyTo()->int())
            );
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'));
            $this->showMembersList();
            return true;
        }

        $this->showAssignmentForm($form);
        return true;
    }

Here is the call graph for this function:

saveForm()

ilMailingListsGUI::saveForm

(

)

Definition at line 326 of file class.ilMailingListsGUI.php.

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

                              : void
    {
        if ($this->mlists->getCurrentMailingList() && $this->mlists->getCurrentMailingList()->getId()) {
            if (!$this->mlists->isOwner($this->mlists->getCurrentMailingList()->getId(), $this->user->getId())) {
                $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
            }

            $this->ctrl->setParameter($this, 'ml_id', $this->mlists->getCurrentMailingList()->getId());
            $this->initForm('edit');
        } else {
            $this->initForm();
        }

        if ($this->form_gui->checkInput()) {
            $this->mlists->getCurrentMailingList()->setTitle(
                $this->form_gui->getInput('title')
            );
            $this->mlists->getCurrentMailingList()->setDescription(
                $this->form_gui->getInput('description')
            );
            if ($this->mlists->getCurrentMailingList()->getId()) {
                $this->mlists->getCurrentMailingList()->setChangedate(date('Y-m-d H:i:s'));
                $this->mlists->getCurrentMailingList()->update();
            } else {
                $this->mlists->getCurrentMailingList()->setCreatedate(date('Y-m-d H:i:s'));
                $this->mlists->getCurrentMailingList()->insert();
            }

            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);
            $this->ctrl->redirect($this, 'showMailingLists');
        }

        $this->tpl->setTitle($this->lng->txt('mail_addressbook'));
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.mail_mailing_lists_form.html', 'Services/Contact');

        $this->form_gui->setValuesByPost();

        $this->tpl->setVariable('FORM', $this->form_gui->getHTML());
        $this->tpl->printToStdout();
    }

Here is the call graph for this function:

setDefaultValues()

ilMailingListsGUI::setDefaultValues ( )

private

Definition at line 395 of file class.ilMailingListsGUI.php.

Referenced by showForm().

                                       : void
    {
        $this->form_gui->setValuesByArray([
            'title' => '',
            'description' => ''
        ]);
    }

Here is the caller graph for this function:

setValuesByObject()

ilMailingListsGUI::setValuesByObject ( )

private

Definition at line 387 of file class.ilMailingListsGUI.php.

Referenced by showForm().

                                        : void
    {
        $this->form_gui->setValuesByArray([
            'title' => $this->mlists->getCurrentMailingList()->getTitle(),
            'description' => $this->mlists->getCurrentMailingList()->getDescription() ?? ''
        ]);
    }

Here is the caller graph for this function:

showAssignmentForm()

ilMailingListsGUI::showAssignmentForm

(

?ilPropertyFormGUI

$form = null

)

Definition at line 664 of file class.ilMailingListsGUI.php.

References ILIAS\Repository\lng(), showMembersList(), and ILIAS\Repository\user().

Referenced by saveAssignmentForm().

                                                                       : bool
    {
        if (!$this->mlists->getCurrentMailingList()->getId()) {
            $this->showMembersList();
            return true;
        }

        if (!$this->mlists->isOwner($this->mlists->getCurrentMailingList()->getId(), $this->user->getId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $this->tpl->setTitle($this->lng->txt('mail_addressbook'));
        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.mail_mailing_lists_members_form.html',
            'Services/Contact'
        );

        if (!($form instanceof ilPropertyFormGUI)) {
            $form = $this->getAssignmentForm();
        }

        $this->tpl->setVariable('FORM', $form->getHTML());
        $this->tpl->printToStdout();

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showForm()

ilMailingListsGUI::showForm

(

)

Definition at line 403 of file class.ilMailingListsGUI.php.

References ILIAS\Repository\ctrl(), initForm(), ILIAS\Repository\lng(), setDefaultValues(), setValuesByObject(), and ILIAS\Repository\user().

                              : void
    {
        $this->tpl->setTitle($this->lng->txt('mail_addressbook'));
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.mail_mailing_lists_form.html', 'Services/Contact');

        if ($this->mlists->getCurrentMailingList() && $this->mlists->getCurrentMailingList()->getId()) {
            if (!$this->mlists->isOwner($this->mlists->getCurrentMailingList()->getId(), $this->user->getId())) {
                $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
            }

            $this->ctrl->setParameter($this, 'ml_id', $this->mlists->getCurrentMailingList()->getId());
            $this->initForm('edit');
            $this->setValuesByObject();
        } else {
            $this->initForm();
            $this->setDefaultValues();
        }

        $this->tpl->setVariable('FORM', $this->form_gui->getHTML());
        $this->tpl->printToStdout();
    }

Here is the call graph for this function:

showMailingLists()

ilMailingListsGUI::showMailingLists

(

)

Definition at line 228 of file class.ilMailingListsGUI.php.

References ILIAS\Repository\ctrl(), ilLegacyFormElementsUtil\formCheckbox(), ilLinkButton\getInstance(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ilMailingList\MODE_TEMPORARY, ILIAS\Repository\refinery(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Referenced by cancel(), confirmDelete(), mailToList(), performDelete(), and showMembersList().

                                      : bool
    {
        $this->tpl->setTitle($this->lng->txt('mail_addressbook'));
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.mail_mailing_lists_list.html', 'Services/Contact');

        // check if current user may send mails
        $mail = new ilMail($this->user->getId());
        $mailing_allowed = $this->rbacsystem->checkAccess('internal_mail', $mail->getMailObjectReferenceId());

        $tbl = new ilMailingListsTableGUI($this, 'showMailingLists');

        $create_btn = ilLinkButton::getInstance();
        $create_btn->setCaption('create');
        $create_btn->setUrl($this->ctrl->getLinkTarget($this, 'showForm'));
        $this->toolbar->addButtonInstance($create_btn);

        $result = [];
        $entries = $this->mlists->getAll();
        if (count($entries)) {
            $tbl->enable('select_all');
            $counter = 0;

            foreach ($entries as $entry) {
                if ($entry->getMode() === ilMailingList::MODE_TEMPORARY) {
                    continue;
                }

                $result[$counter]['check'] = ilLegacyFormElementsUtil::formCheckbox(false, 'ml_id[]', (string) $entry->getId());
                $result[$counter]['title'] = $entry->getTitle() . " [#il_ml_" . $entry->getId() . "]";
                $result[$counter]['description'] = $entry->getDescription() ?? '';
                $result[$counter]['members'] = count($entry->getAssignedEntries());

                $this->ctrl->setParameter($this, 'ml_id', $entry->getId());

                $current_selection_list = new ilAdvancedSelectionListGUI();
                $current_selection_list->setListTitle($this->lng->txt("actions"));
                $current_selection_list->setId("act_" . $counter);

                $current_selection_list->addItem(
                    $this->lng->txt("edit"),
                    '',
                    $this->ctrl->getLinkTarget($this, "showForm")
                );
                $current_selection_list->addItem(
                    $this->lng->txt("members"),
                    '',
                    $this->ctrl->getLinkTarget($this, "showMembersList")
                );
                if ($mailing_allowed) {
                    $current_selection_list->addItem(
                        $this->lng->txt("send_mail_to"),
                        '',
                        $this->ctrl->getLinkTarget($this, "mailToList")
                    );
                }
                $current_selection_list->addItem(
                    $this->lng->txt("delete"),
                    '',
                    $this->ctrl->getLinkTarget($this, "confirmDelete")
                );

                $result[$counter]['COMMAND_SELECTION_LIST'] = $current_selection_list->getHTML();
                ++$counter;
            }

            if ($mailing_allowed) {
                $tbl->addMultiCommand('mailToList', $this->lng->txt('send_mail_to'));
            }
            $tbl->addMultiCommand('confirmDelete', $this->lng->txt('delete'));
        } else {
            $tbl->disable('header');
            $tbl->disable('footer');
        }

        $tbl->setData($result);

        if (
            $this->http->wrapper()->query()->has('ref') &&
            $this->http->wrapper()->query()->retrieve('ref', $this->refinery->kindlyTo()->string()) === 'mail') {
            $tbl->addCommandButton('cancel', $this->lng->txt('cancel'));
        }

        $this->tpl->setVariable('MAILING_LISTS', $tbl->getHTML());
        $this->tpl->printToStdout();
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showMembersList()

ilMailingListsGUI::showMembersList

(

)

Definition at line 425 of file class.ilMailingListsGUI.php.

References ilTable2GUI\addMultiCommand(), ILIAS\Repository\ctrl(), ilLegacyFormElementsUtil\formCheckbox(), ilBuddySystemRelation\getBuddyUsrId(), ilLinkButton\getInstance(), ilBuddyList\getInstanceByGlobalUser(), ilUserUtil\getNamePresentation(), ILIAS\Repository\lng(), showMailingLists(), and ILIAS\Repository\toolbar().

Referenced by confirmDeleteMembers(), performDeleteMembers(), saveAssignmentForm(), and showAssignmentForm().

                                     : bool
    {
        if (!$this->mlists->getCurrentMailingList()->getId()) {
            $this->showMailingLists();
            return true;
        }

        $this->ctrl->setParameter($this, 'ml_id', $this->mlists->getCurrentMailingList()->getId());

        $this->tpl->setTitle($this->lng->txt('mail_addressbook'));
        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.mail_mailing_lists_members.html',
            'Services/Contact'
        );

        $tbl = new ilMailingListsMembersTableGUI($this, 'showMembersList', $this->mlists->getCurrentMailingList());
        $result = [];

        $availale_usr_ids = array_diff(
            array_map(
                static function (ilBuddySystemRelation $relation): int {
                    return $relation->getBuddyUsrId();
                },
                ilBuddyList::getInstanceByGlobalUser()->getLinkedRelations()->toArray()
            ),
            array_map(
                static function (array $entry): int {
                    return $entry['usr_id'];
                },
                $this->mlists->getCurrentMailingList()->getAssignedEntries()
            ),
        );

        if (count($availale_usr_ids) > 0) {
            $create_btn = ilLinkButton::getInstance();
            $create_btn->setCaption('add');
            $create_btn->setUrl($this->ctrl->getLinkTarget($this, 'showAssignmentForm'));
            $this->toolbar->addButtonInstance($create_btn);
        }

        $assigned_entries = $this->mlists->getCurrentMailingList()->getAssignedEntries();
        if (count($assigned_entries)) {
            $tbl->enable('select_all');
            $tbl->setSelectAllCheckbox('a_id');

            $usr_ids = [];
            foreach ($assigned_entries as $entry) {
                $usr_ids[] = $entry['usr_id'];
            }

            $names = ilUserUtil::getNamePresentation($usr_ids, false, false, '', false, false, false);

            $counter = 0;
            foreach ($assigned_entries as $entry) {
                $result[$counter]['check'] = ilLegacyFormElementsUtil::formCheckbox(false, 'a_id[]', (string) $entry['a_id']);
                $result[$counter]['user'] = $names[$entry['usr_id']];
                ++$counter;
            }

            $tbl->addMultiCommand('confirmDeleteMembers', $this->lng->txt('delete'));
        } else {
            $tbl->disable('header');
            $tbl->disable('footer');

            $tbl->setNoEntriesText($this->lng->txt('mail_search_no'));
        }

        $tbl->setData($result);

        $this->tpl->setVariable('MEMBERS_LIST', $tbl->getHTML());
        $this->tpl->printToStdout();
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilCtrlInterface ilMailingListsGUI::$ctrl

private

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

$error

ilErrorHandling ilMailingListsGUI::$error

private

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

$form_gui

ilPropertyFormGUI ilMailingListsGUI::$form_gui

private

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

$http

ILIAS HTTP GlobalHttpState ilMailingListsGUI::$http

private

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

$lng

ilLanguage ilMailingListsGUI::$lng

private

Definition at line 33 of file class.ilMailingListsGUI.php.

$mlists

ilMailingLists ilMailingListsGUI::$mlists

private

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

$rbacsystem

ilRbacSystem ilMailingListsGUI::$rbacsystem

private

Definition at line 37 of file class.ilMailingListsGUI.php.

$refinery

Refinery ilMailingListsGUI::$refinery

private

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

$toolbar

ilToolbarGUI ilMailingListsGUI::$toolbar

private

Definition at line 36 of file class.ilMailingListsGUI.php.

$tpl

ilGlobalTemplateInterface ilMailingListsGUI::$tpl

private

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

$umail

ilFormatMail ilMailingListsGUI::$umail

private

Definition at line 38 of file class.ilMailingListsGUI.php.

$user

ilObjUser ilMailingListsGUI::$user

private

Definition at line 34 of file class.ilMailingListsGUI.php.

---

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

• Services/Contact/classes/class.ilMailingListsGUI.php