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)

Protected Member Functions
	nextMailForm ()

	generateContextArray ()

	showSelectableUsers ()

	sendMailToSelectedUsers ()

	showSearchForm ()

	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 27 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 46 of file class.ilMailMemberSearchGUI.php.

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

       {
         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);
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilMailMemberSearchGUI::executeCommand ( )

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

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

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

Here is the call graph for this function:

◆ generateContextArray()

ilMailMemberSearchGUI::generateContextArray ( )

protected

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

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.

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 342 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']) {
                 $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 337 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 306 of file class.ilMailMemberSearchGUI.php.

References $objParticipants.

Referenced by sendMailToSelectedUsers(), and showSelectableUsers().

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

Here is the caller graph for this function:

◆ getStoredReferer()

ilMailMemberSearchGUI::getStoredReferer ( )

private

Definition at line 147 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:

◆ handleSearchMembersActions()

ilMailMemberSearchGUI::handleSearchMembersActions ( )

private

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

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

Referenced by executeCommand().

                                                  : 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'),
         };
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initMailToMembersForm()

ilMailMemberSearchGUI::initMailToMembersForm ( )

protected

Definition at line 316 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 157 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')) && $form->getInput('roles') !== []) {
                     $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 119 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 249 of file class.ilMailMemberSearchGUI.php.

References $provider, ilObjUser\_lookupLogin(), ILIAS\Repository\ctrl(), generateContextArray(), 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().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setObjParticipants()

ilMailMemberSearchGUI::setObjParticipants ( ilParticipants $objParticipants )

Definition at line 311 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 298 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 240 of file class.ilMailMemberSearchGUI.php.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storeReferer()

ilMailMemberSearchGUI::storeReferer ( )

Definition at line 126 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 (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);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unsetStoredReferer()

ilMailMemberSearchGUI::unsetStoredReferer ( )

private

Definition at line 152 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

readonly ilAccessHandler ilMailMemberSearchGUI::$access

private

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

◆ $ctrl

readonly ilCtrlInterface ilMailMemberSearchGUI::$ctrl

private

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

◆ $http

readonly Services ilMailMemberSearchGUI::$http

private

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

◆ $httpRequest

readonly ServerRequestInterface ilMailMemberSearchGUI::$httpRequest

private

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

◆ $lng

readonly ilLanguage ilMailMemberSearchGUI::$lng

private

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

◆ $mail_roles

readonly array ilMailMemberSearchGUI::$mail_roles

private

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

Referenced by getMailRoles().

◆ $objParticipants

ilParticipants ilMailMemberSearchGUI::$objParticipants = null

private

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

Referenced by getObjParticipants(), and setObjParticipants().

◆ $refinery

readonly Factory ilMailMemberSearchGUI::$refinery

private

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

◆ $tpl

readonly ilGlobalTemplateInterface ilMailMemberSearchGUI::$tpl

private

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

◆ $ui_factory

readonly ILIAS UI Factory ilMailMemberSearchGUI::$ui_factory

private

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

◆ $ui_renderer

readonly Renderer ilMailMemberSearchGUI::$ui_renderer

private

Definition at line 39 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()

◆ getStoredReferer()

◆ 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