Inheritance diagram for ilMailMemberSearchGUI:

Collaboration diagram for ilMailMemberSearchGUI:

Public Member Functions
	__construct (private readonly object $gui, public int $ref_id, private readonly ilAbstractMailMemberRoles $objMailMemberRoles)

	executeCommand ()

	storeReferer ()

	setObjParticipants (ilParticipants $objParticipants)

	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...

	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...

	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

Protected Member Functions
	nextMailForm ()

	generateContextArray ()

	showSelectableUsers ()

	sendMailToSelectedUsers ()

	showSearchForm (?StandardForm $form=null)

	getObjParticipants ()

	initMailToMembersForm ()

	getMailRadioGroup ()

Private Member Functions
	handleSearchMembersActions ()

	redirectToParentReferer ()

	getStoredReferer ()

	unsetStoredReferer ()

	getMailRoles ()

Private Attributes
readonly ServerRequestInterface	$httpRequest

readonly array	$mail_roles

ilParticipants	$objParticipants = null

readonly ilCtrlInterface	$ctrl

readonly ilGlobalTemplateInterface	$tpl

readonly ilLanguage	$lng

readonly ilAccessHandler	$access

readonly ILIAS UI Factory	$ui_factory

readonly Services	$http

readonly Renderer	$ui_renderer

readonly Factory	$refinery

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

ilObjGroupGUI \| ilObjCourseGUI \| ilMembershipGUI	$gui
ilAbstractMailMemberRoles	$objMailMemberRoles

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

      {
        global $DIC;
 
        $this->ctrl = $DIC['ilCtrl'];
        $this->tpl = $DIC['tpl'];
        $this->lng = $DIC['lng'];
        $this->access = $DIC['ilAccess'];
        $this->httpRequest = $DIC->http()->request();
 
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->refinery = $DIC->refinery();
        $this->http = $DIC->http();
 
        $this->lng->loadLanguageModule('mail');
        $this->lng->loadLanguageModule('search');
        $this->mail_roles = $objMailMemberRoles->getMailRoles($ref_id);
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilMailMemberSearchGUI::executeCommand ( )

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

                                    : bool
    {
        $cmd = $this->ctrl->getCmd();
 
        $this->ctrl->setReturn($this, '');
 
        switch ($cmd) {
            case 'handleSearchMembersActions':
                $this->handleSearchMembersActions();
                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;
    }

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

Here is the call graph for this function:

◆ generateContextArray()

ilMailMemberSearchGUI::generateContextArray ( )

protected

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

                                             : 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;
    }

References $ref_id, 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.

Here is the call graph for this function:

◆ getMailRadioGroup()

ilMailMemberSearchGUI::getMailRadioGroup ( )

protected

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

                                          : ILIAS\UI\Component\Input\Field\SwitchableGroup
    {
        $mail_roles = $this->getMailRoles();
 
        $sub_items = [];
        $values = [];
        foreach ($mail_roles as $role) {
            $chk_role = $this->ui_factory->input()->field()->checkbox($role['form_option_title'], $role['mailbox']);
            $sub_items[$role['role_id']] = $chk_role;
            if (isset($role['default_checked']) && $role['default_checked']) {
                $values[$role['role_id']] = true;
            } else {
                $values[$role['role_id']] = false;
            }
        }
 
        return $this->ui_factory->input()->field()->switchableGroup(
            [
                'mail_sel_users' => $this->ui_factory->input()->field()->group([], $this->lng->txt('mail_sel_users')),
                'mail_member_roles' => $this->ui_factory->input()->field()->group(
                    $sub_items,
                    $this->objMailMemberRoles->getRadioOptionTitle()
                )
            ],
            $this->lng->txt('mail_sel_label')
        )->withValue(
            [
                'mail_member_roles',
                $values
            ]
        );
    }

References $mail_roles, and getMailRoles().

Here is the call 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 338 of file class.ilMailMemberSearchGUI.php.

                                   : array
    {
        return $this->mail_roles;
    }

References $mail_roles.

Referenced by getMailRadioGroup().

Here is the caller graph for this function:

◆ getObjParticipants()

ilMailMemberSearchGUI::getObjParticipants ( )

protected

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

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

References $objParticipants.

Referenced by sendMailToSelectedUsers(), and showSelectableUsers().

Here is the caller graph for this function:

◆ getSafePostCommands()

ilMailMemberSearchGUI::getSafePostCommands ( )

This method must return a list of safe POST commands.

Safe post commands returned by this method will no longer be CSRF protected and will NOT be appended by an ilCtrlToken.

Returns: string[]

Implements ilCtrlSecurityInterface.

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

                                         : array
    {
        return [];
    }

◆ getStoredReferer()

ilMailMemberSearchGUI::getStoredReferer ( )

private

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

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

References ilSession\get().

Referenced by redirectToParentReferer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUnsafeGetCommands()

ilMailMemberSearchGUI::getUnsafeGetCommands ( )

This method must return a list of unsafe GET commands.

Unsafe get commands returned by this method will now be CSRF protected, which means an ilCtrlToken is appended each time a link-target is generated to the class implementing this interface with a command from that list.

Tokens will be validated in

See also: ilCtrlInterface::getCmd(), whereas the fallback command will be used if the CSRF validation fails.

Returns: string[]

Implements ilCtrlSecurityInterface.

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

                                          : array
    {
        return [
            'handleSearchMembersActions'
        ];
    }

◆ handleSearchMembersActions()

ilMailMemberSearchGUI::handleSearchMembersActions ( )

private

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

                                                 : void
    {
        $action = $this->http->wrapper()->query()->retrieve(
            'contact_search_members_action',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $this->refinery->always('')
            ])
        );
        match ($action) {
            'sendMailToSelectedUsers' => $this->sendMailToSelectedUsers(),
            default => $this->ctrl->redirect($this, 'showSelectableUsers'),
        };
    }

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initMailToMembersForm()

ilMailMemberSearchGUI::initMailToMembersForm ( )

protected

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

                                              : StandardForm
    {
        $this->lng->loadLanguageModule('mail');
 
        return $this->ui_factory->input()->container()->form()->standard(
            $this->ctrl->getFormAction($this, 'nextMailForm'),
            [
                'mail_member_type' => $this->getMailRadioGroup()
            ]
        );
    }

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

Referenced by nextMailForm(), and showSearchForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nextMailForm()

ilMailMemberSearchGUI::nextMailForm ( )

protected

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

                                     : void
    {
        $form = $this->initMailToMembersForm();
        $form = $form->withRequest($this->http->request());
        if (!$form->getError()) {
            $data = $form->getData();
 
            if (isset($data['mail_member_type']) && $data['mail_member_type'][0] === 'mail_member_roles') {
                if ($data['mail_member_type'][1]) {
                    $role_mail_boxes = [];
                    $roles = $data['mail_member_type'][1];
                    foreach ($roles as $role_id => $enabled) {
                        if ($enabled) {
                            $role_mail_boxes[] = $this->objMailMemberRoles->getMailboxRoleAddress((int) $role_id);
                        }
                    }
 
                    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 {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_checkbox'));
                    $this->showSearchForm($form);
 
                    return;
                }
            } else {
                $this->showSelectableUsers();
 
                return;
            }
        }
 
        $this->showSearchForm($form);
    }

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ redirectToParentReferer()

ilMailMemberSearchGUI::redirectToParentReferer ( )

private

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

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

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendMailToSelectedUsers()

ilMailMemberSearchGUI::sendMailToSelectedUsers ( )

protected

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

                                                : void
    {
        $selected_user_ids = $this->http->wrapper()->query()->retrieve(
            'contact_search_members_user_ids',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string()),
                $this->refinery->always([])
            ])
        );
 
        if ((string) current($selected_user_ids) === 'ALL_OBJECTS') {
            $selected_user_ids = [];
            $provider = new ilMailMemberSearchDataProvider($this->getObjParticipants(), $this->ref_id);
            $entries = $provider->getData();
 
            foreach ($entries as $entry) {
                $selected_user_ids[] = (int) $entry['user_id'];
            }
        } else {
            $selected_user_ids = array_map(intval(...), $selected_user_ids);
        }
 
        $rcps = [];
        foreach ($selected_user_ids as $usr_id) {
            $rcps[] = ilObjUser::_lookupLogin($usr_id);
        }
 
        if (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()
            )
        );
    }

References $provider, ilObjUser\_lookupLogin(), ILIAS\Repository\ctrl(), getObjParticipants(), ilMailFormCall\getRedirectTarget(), ILIAS\FileDelivery\http(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ilMailFormGUI\MAIL_FORM_TYPE_NEW, ILIAS\Repository\refinery(), ilMailFormCall\setRecipients(), and showSelectableUsers().

Referenced by handleSearchMembersActions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setObjParticipants()

ilMailMemberSearchGUI::setObjParticipants ( ilParticipants $objParticipants )

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

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

References $objParticipants.

◆ showSearchForm()

ilMailMemberSearchGUI::showSearchForm ( ?StandardForm $form = null )

protected

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

                                                                 : void
    {
        $this->storeReferer();
 
        if (!$form instanceof StandardForm) {
            $form = $this->initMailToMembersForm();
        }
        $this->tpl->setContent($this->ui_renderer->render($form));
    }

References initMailToMembersForm(), and storeReferer().

Referenced by executeCommand(), and nextMailForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showSelectableUsers()

ilMailMemberSearchGUI::showSelectableUsers ( )

protected

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

                                            : void
    {
        $this->tpl->loadStandardTemplate();
        $provider = new ilMailMemberSearchDataProvider($this->getObjParticipants(), $this->ref_id);
        $tbl = new MailMemberSearchTable($this->ref_id, $provider, $this->ctrl, $this->lng, $this->ui_factory, $this->http);
 
        $this->tpl->setContent($this->ui_renderer->render($tbl->getComponent()));
    }

References $provider, ILIAS\Repository\ctrl(), getObjParticipants(), ILIAS\FileDelivery\http(), and ILIAS\Repository\lng().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storeReferer()

ilMailMemberSearchGUI::storeReferer ( )

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

                                  : 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 (is_array($urlParts) && 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);
    }

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

Referenced by showSearchForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unsetStoredReferer()

ilMailMemberSearchGUI::unsetStoredReferer ( )

private

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

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

References ilSession\set().

Referenced by redirectToParentReferer().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $access

readonly ilAccessHandler ilMailMemberSearchGUI::$access

private

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

◆ $ctrl

readonly ilCtrlInterface ilMailMemberSearchGUI::$ctrl

private

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

◆ $http

readonly Services ilMailMemberSearchGUI::$http

private

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

◆ $httpRequest

readonly ServerRequestInterface ilMailMemberSearchGUI::$httpRequest

private

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

◆ $lng

readonly ilLanguage ilMailMemberSearchGUI::$lng

private

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

◆ $mail_roles

readonly array ilMailMemberSearchGUI::$mail_roles

private

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

Referenced by getMailRadioGroup(), and getMailRoles().

◆ $objParticipants

ilParticipants ilMailMemberSearchGUI::$objParticipants = null

private

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

Referenced by getObjParticipants(), and setObjParticipants().

◆ $refinery

readonly Factory ilMailMemberSearchGUI::$refinery

private

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

◆ $tpl

readonly ilGlobalTemplateInterface ilMailMemberSearchGUI::$tpl

private

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

◆ $ui_factory

readonly ILIAS UI Factory ilMailMemberSearchGUI::$ui_factory

private

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

◆ $ui_renderer

readonly Renderer ilMailMemberSearchGUI::$ui_renderer

private

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

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

components/ILIAS/Contact/classes/class.ilMailMemberSearchGUI.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ executeCommand()

◆ generateContextArray()

◆ getMailRadioGroup()

◆ getMailRoles()

◆ getObjParticipants()

◆ getSafePostCommands()

◆ getStoredReferer()

◆ getUnsafeGetCommands()

◆ handleSearchMembersActions()

◆ initMailToMembersForm()

◆ nextMailForm()

◆ redirectToParentReferer()

◆ sendMailToSelectedUsers()

◆ setObjParticipants()

◆ showSearchForm()

◆ showSelectableUsers()

◆ storeReferer()

◆ unsetStoredReferer()

Field Documentation

◆ $access

◆ $ctrl

◆ $http

◆ $httpRequest

◆ $lng

◆ $mail_roles

◆ $objParticipants

◆ $refinery

◆ $tpl

◆ $ui_factory

◆ $ui_renderer