ilMailMemberSearchGUI Class Reference

Class ilMailMemberSearchGUI. More...

Collaboration diagram for ilMailMemberSearchGUI:

Public Member Functions
	__construct (object $gui, int $ref_id, ilAbstractMailMemberRoles $objMailMemberRoles)
	ilMailMemberSearchGUI constructor. More...
	executeCommand ()
	storeReferer ()
	setObjParticipants (ilParticipants $objParticipants)

Data Fields
int	$ref_id

Protected Member Functions
	nextMailForm ()
	generateContextArray ()
	showSelectableUsers ()
	sendMailToSelectedUsers ()
	showSearchForm ()
	getObjParticipants ()
	initMailToMembersForm ()
	getMailRadioGroup ()

Private Member Functions
	redirectToParentReferer ()
	getStoredReferer ()
	unsetStoredReferer ()
	getMailRoles ()

Private Attributes
ServerRequestInterface	$httpRequest
array	$mail_roles
	$gui
ilAbstractMailMemberRoles	$objMailMemberRoles
ilParticipants	$objParticipants
ilCtrlInterface	$ctrl
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilAccessHandler	$access

Detailed Description

Class ilMailMemberSearchGUI.

Author

Nadia Matuschek nmatu.nosp@m.sche.nosp@m.k@dat.nosp@m.abay.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilMailMemberSearchGUI::__construct	(	object	$gui,
		int	$ref_id,
		ilAbstractMailMemberRoles	$objMailMemberRoles
	)

ilMailMemberSearchGUI constructor.

Parameters

ilObjGroupGUI | ilObjCourseGUI | ilMembershipGUI	$gui
int	$ref_id
ilAbstractMailMemberRoles	$objMailMemberRoles

Definition at line 49 of file class.ilMailMemberSearchGUI.php.

References $DIC, $gui, $objMailMemberRoles, $ref_id, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilAbstractMailMemberRoles\getMailRoles(), and ILIAS\Repository\lng().

    {
        global $DIC;

        $this->ctrl = $DIC['ilCtrl'];
        $this->tpl = $DIC['tpl'];
        $this->lng = $DIC['lng'];
        $this->access = $DIC['ilAccess'];
        $this->httpRequest = $DIC->http()->request();

        $this->lng->loadLanguageModule('mail');
        $this->lng->loadLanguageModule('search');

        $this->gui = $gui;
        $this->ref_id = $ref_id;

        $this->objMailMemberRoles = $objMailMemberRoles;
        $this->mail_roles = $objMailMemberRoles->getMailRoles($ref_id);
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilMailMemberSearchGUI::executeCommand

(

)

Definition at line 70 of file class.ilMailMemberSearchGUI.php.

References ILIAS\Repository\ctrl(), nextMailForm(), redirectToParentReferer(), sendMailToSelectedUsers(), showSearchForm(), and showSelectableUsers().

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

        $this->ctrl->setReturn($this, '');

        switch ($cmd) {
            case 'sendMailToSelectedUsers':
                $this->sendMailToSelectedUsers();
                break;

            case 'showSelectableUsers':
                $this->showSelectableUsers();
                break;

            case 'nextMailForm':
                $this->nextMailForm();
                break;

            case 'cancel':
                $this->redirectToParentReferer();
                break;

            default:
                if (isset($this->httpRequest->getQueryParams()['returned_from_mail']) && $this->httpRequest->getQueryParams()['returned_from_mail'] === '1') {
                    $this->redirectToParentReferer();
                }
                $this->showSearchForm();
                break;
        }


        return true;
    }

Here is the call graph for this function:

generateContextArray()

ilMailMemberSearchGUI::generateContextArray ( )

protected

Definition at line 187 of file class.ilMailMemberSearchGUI.php.

References $ref_id, $type, ilContainer\_lookupContainerSetting(), ilObject\_lookupObjId(), ilObject\_lookupType(), ILIAS\Repository\access(), ilMailFormCall\CONTEXT_KEY, ilObjectServiceSettingsGUI\EXTERNAL_MAIL_PREFIX, ilCourseMailTemplateTutorContext\ID, ilSessionMailTemplateParticipantContext\ID, and ilMail\PROP_CONTEXT_SUBJECT_PREFIX.

Referenced by nextMailForm(), and sendMailToSelectedUsers().

                                             : array
    {
        $contextParameters = [];

        $type = ilObject::_lookupType($this->ref_id, true);
        switch ($type) {
            case 'grp':
            case 'crs':
                if ($this->access->checkAccess('write', '', $this->ref_id)) {
                    $contextParameters = [
                        'ref_id' => $this->ref_id,
                        'ts' => time(),
                        ilMail::PROP_CONTEXT_SUBJECT_PREFIX => ilContainer::_lookupContainerSetting(
                            ilObject::_lookupObjId($this->ref_id),
                            ilObjectServiceSettingsGUI::EXTERNAL_MAIL_PREFIX,
                            ''
                        )
                    ];

                    if ('crs' === $type) {
                        $contextParameters[ilMailFormCall::CONTEXT_KEY] = ilCourseMailTemplateTutorContext::ID;
                    }
                }
                break;

            case 'sess':
                if ($this->access->checkAccess('write', '', $this->ref_id)) {
                    $contextParameters = [
                        ilMailFormCall::CONTEXT_KEY => ilSessionMailTemplateParticipantContext::ID,
                        'ref_id' => $this->ref_id,
                        'ts' => time()
                    ];
                }
                break;
        }

        return $contextParameters;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMailRadioGroup()

ilMailMemberSearchGUI::getMailRadioGroup ( )

protected

Definition at line 320 of file class.ilMailMemberSearchGUI.php.

References ilRadioOption\addSubItem(), getMailRoles(), and ILIAS\Repository\lng().

Referenced by initMailToMembersForm().

                                          : ilRadioGroupInputGUI
    {
        $mail_roles = $this->getMailRoles();

        $radio_grp = new ilRadioGroupInputGUI($this->lng->txt('mail_sel_label'), 'mail_member_type');

        $radio_sel_users = new ilRadioOption($this->lng->txt('mail_sel_users'), 'mail_sel_users');

        $radio_roles = new ilRadioOption($this->objMailMemberRoles->getRadioOptionTitle(), 'mail_member_roles');
        foreach ($mail_roles as $role) {
            $chk_role = new ilCheckboxInputGUI($role['form_option_title'], 'roles[' . $role['role_id'] . ']');

            if (isset($role['default_checked']) && $role['default_checked'] === true) {
                $chk_role->setChecked(true);
            }
            $chk_role->setValue((string) $role['role_id']);
            $chk_role->setInfo($role['mailbox']);
            $radio_roles->addSubItem($chk_role);
        }

        $radio_grp->setValue('mail_member_roles');

        $radio_grp->addOption($radio_sel_users);
        $radio_grp->addOption($radio_roles);

        return $radio_grp;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMailRoles()

ilMailMemberSearchGUI::getMailRoles ( )

private

Returns

array{role_id: int, mailbox: string, form_option_title: string, default_checked?: bool}[]

Definition at line 314 of file class.ilMailMemberSearchGUI.php.

References $mail_roles.

Referenced by getMailRadioGroup().

                                   : array
    {
        return $this->mail_roles;
    }

Here is the caller graph for this function:

getObjParticipants()

ilMailMemberSearchGUI::getObjParticipants ( )

protected

Definition at line 279 of file class.ilMailMemberSearchGUI.php.

References $objParticipants.

Referenced by showSelectableUsers().

                                           : ?ilParticipants
    {
        return $this->objParticipants;
    }

Here is the caller graph for this function:

getStoredReferer()

ilMailMemberSearchGUI::getStoredReferer ( )

private

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

References ilSession\get().

Referenced by redirectToParentReferer().

                                       : string
    {
        return (string) ilSession::get('ilMailMemberSearchGUIReferer');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initMailToMembersForm()

ilMailMemberSearchGUI::initMailToMembersForm ( )

protected

Definition at line 293 of file class.ilMailMemberSearchGUI.php.

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

Referenced by nextMailForm(), and showSearchForm().

                                              : ilPropertyFormGUI
    {
        $this->lng->loadLanguageModule('mail');

        $form = new ilPropertyFormGUI();
        $form->setTitle($this->lng->txt('mail_members'));

        $form->setFormAction($this->ctrl->getFormAction($this, 'nextMailForm'));

        $radio_grp = $this->getMailRadioGroup();

        $form->addItem($radio_grp);
        $form->addCommandButton('nextMailForm', $this->lng->txt('mail_members_search_continue'));
        $form->addCommandButton('cancel', $this->lng->txt('cancel'));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

nextMailForm()

ilMailMemberSearchGUI::nextMailForm ( )

protected

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

References ILIAS\Repository\ctrl(), generateContextArray(), ilMailFormCall\getRedirectTarget(), initMailToMembersForm(), ILIAS\Repository\lng(), ilMailFormGUI\MAIL_FORM_TYPE_ROLE, ilSession\set(), showSearchForm(), and showSelectableUsers().

Referenced by executeCommand().

                                     : void
    {
        $form = $this->initMailToMembersForm();
        if ($form->checkInput()) {
            if ($form->getInput('mail_member_type') === 'mail_member_roles') {
                if (is_array($form->getInput('roles')) && count($form->getInput('roles')) > 0) {
                    $role_mail_boxes = [];
                    $roles = $form->getInput('roles');
                    foreach ($roles as $role_id) {
                        $mailbox = $this->objMailMemberRoles->getMailboxRoleAddress((int) $role_id);
                        $role_mail_boxes[] = $mailbox;
                    }

                    ilSession::set('mail_roles', $role_mail_boxes);

                    $this->ctrl->redirectToURL(ilMailFormCall::getRedirectTarget(
                        $this,
                        'showSearchForm',
                        ['type' => ilMailFormGUI::MAIL_FORM_TYPE_ROLE],
                        [
                            'type' => ilMailFormGUI::MAIL_FORM_TYPE_ROLE,
                            'rcp_to' => implode(',', $role_mail_boxes),
                            'sig' => $this->gui->createMailSignature()
                        ],
                        $this->generateContextArray()
                    ));
                } else {
                    $form->setValuesByPost();
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_checkbox'));
                    $this->showSearchForm();
                    return;
                }
            } else {
                $this->showSelectableUsers();
                return;
            }
        }

        $form->setValuesByPost();
        $this->showSearchForm();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

redirectToParentReferer()

ilMailMemberSearchGUI::redirectToParentReferer ( )

private

Definition at line 106 of file class.ilMailMemberSearchGUI.php.

References $url, ILIAS\Repository\ctrl(), getStoredReferer(), and unsetStoredReferer().

Referenced by executeCommand().

                                              : void
    {
        $url = $this->getStoredReferer();
        $this->unsetStoredReferer();
        $this->ctrl->redirectToURL($url);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendMailToSelectedUsers()

ilMailMemberSearchGUI::sendMailToSelectedUsers ( )

protected

Definition at line 237 of file class.ilMailMemberSearchGUI.php.

References ilObjUser\_lookupLogin(), ILIAS\Repository\ctrl(), generateContextArray(), ilMailFormCall\getRedirectTarget(), ILIAS\Repository\lng(), ilMailFormGUI\MAIL_FORM_TYPE_NEW, ilMailFormCall\setRecipients(), and showSelectableUsers().

Referenced by executeCommand().

                                                : void
    {
        if (!isset($this->httpRequest->getParsedBody()['user_ids']) || !is_array($this->httpRequest->getParsedBody()['user_ids']) || 0 === count($this->httpRequest->getParsedBody()['user_ids'])) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("no_checkbox"));
            $this->showSelectableUsers();
            return;
        }

        $rcps = [];
        foreach ($this->httpRequest->getParsedBody()['user_ids'] as $usr_id) {
            $rcps[] = ilObjUser::_lookupLogin((int) $usr_id);
        }

        if (!count(array_filter($rcps))) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("no_checkbox"));
            $this->showSelectableUsers();
            return;
        }

        ilMailFormCall::setRecipients($rcps);

        $this->ctrl->redirectToURL(ilMailFormCall::getRedirectTarget(
            $this,
            'members',
            [],
            [
                'type' => ilMailFormGUI::MAIL_FORM_TYPE_NEW,
                'sig' => $this->gui->createMailSignature(),
            ],
            $this->generateContextArray()
        ));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setObjParticipants()

ilMailMemberSearchGUI::setObjParticipants

(

ilParticipants

$objParticipants

)

Parameters

ilParticipants

$objParticipants

Definition at line 287 of file class.ilMailMemberSearchGUI.php.

References $objParticipants.

Referenced by ilObjGroupGUI\executeCommand(), and ilObjCourseGUI\executeCommand().

                                                                       : void
    {
        $this->objParticipants = $objParticipants;
    }

Here is the caller graph for this function:

showSearchForm()

ilMailMemberSearchGUI::showSearchForm ( )

protected

Definition at line 270 of file class.ilMailMemberSearchGUI.php.

References initMailToMembersForm(), and storeReferer().

Referenced by executeCommand(), and nextMailForm().

                                       : void
    {
        $this->storeReferer();

        $form = $this->initMailToMembersForm();
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showSelectableUsers()

ilMailMemberSearchGUI::showSelectableUsers ( )

protected

Definition at line 226 of file class.ilMailMemberSearchGUI.php.

References $provider, and getObjParticipants().

Referenced by executeCommand(), nextMailForm(), and sendMailToSelectedUsers().

                                            : void
    {
        $this->tpl->loadStandardTemplate();
        $tbl = new ilMailMemberSearchTableGUI($this, 'showSelectableUsers');
        $provider = new ilMailMemberSearchDataProvider($this->getObjParticipants(), $this->ref_id);
        $tbl->setData($provider->getData());

        $this->tpl->setContent($tbl->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

storeReferer()

ilMailMemberSearchGUI::storeReferer

(

)

Definition at line 113 of file class.ilMailMemberSearchGUI.php.

References $url, ILIAS\Repository\ctrl(), and ilSession\set().

Referenced by showSearchForm().

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

        if (isset($this->httpRequest->getServerParams()['HTTP_REFERER'])) {
            $referer = $this->httpRequest->getServerParams()['HTTP_REFERER'];
            $urlParts = parse_url($referer);

            if (isset($urlParts['path'])) {
                $url = ltrim(basename($urlParts['path']), '/');
                if (isset($urlParts['query'])) {
                    $url .= '?' . $urlParts['query'];
                }
                if ($url !== '') {
                    $back_link = $url;
                }
            }
        }

        ilSession::set('ilMailMemberSearchGUIReferer', $back_link);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

unsetStoredReferer()

ilMailMemberSearchGUI::unsetStoredReferer ( )

private

Definition at line 140 of file class.ilMailMemberSearchGUI.php.

References ilSession\set().

Referenced by redirectToParentReferer().

                                         : void
    {
        ilSession::set('ilMailMemberSearchGUIReferer', '');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilMailMemberSearchGUI::$access

private

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

$ctrl

ilCtrlInterface ilMailMemberSearchGUI::$ctrl

private

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

$gui

ilMailMemberSearchGUI::$gui

private

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

Referenced by __construct().

$httpRequest

ServerRequestInterface ilMailMemberSearchGUI::$httpRequest

private

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

$lng

ilLanguage ilMailMemberSearchGUI::$lng

private

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

$mail_roles

array ilMailMemberSearchGUI::$mail_roles

private

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

Referenced by getMailRoles().

$objMailMemberRoles

ilAbstractMailMemberRoles ilMailMemberSearchGUI::$objMailMemberRoles

private

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

Referenced by __construct().

$objParticipants

ilParticipants ilMailMemberSearchGUI::$objParticipants

private

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

Referenced by getObjParticipants(), and setObjParticipants().

$ref_id

int ilMailMemberSearchGUI::$ref_id

Definition at line 41 of file class.ilMailMemberSearchGUI.php.

Referenced by __construct(), and generateContextArray().

$tpl

ilGlobalTemplateInterface ilMailMemberSearchGUI::$tpl

private

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

---

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

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