Collaboration diagram for ilContactGUI:

Public Member Functions
	__construct (string $format_mail_class=ilFormatMail::class, string $relations_table_class=RelationsTable::class)

	executeCommand ()

	submitInvitation ()

Data Fields
final const string	CONTACTS_VIEW_GALLERY = 'buddy_view_gallery'

final const string	CONTACTS_VIEW_TABLE = 'buddy_view_table'

Protected Member Functions
	activateTab (string $a_id)

	changeContactsView ()
	This method is used to switch the contacts view between gallery and table in the mail system. More...

	showContacts ()

	mailToUsers (array $usr_ids)

	inviteToChat (array $usr_ids)

Protected Attributes
ilGlobalTemplateInterface	$tpl

ilCtrlInterface	$ctrl

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ilHelpGUI	$help

ilToolbarGUI	$toolbar

ilFormatMail	$umail

ilObjUser	$user

ilErrorHandling	$error

ilRbacSystem	$rbacsystem

bool	$has_sub_tabs = false

Refinery	$refinery

ILIAS UI Factory	$ui_factory

ILIAS UI Renderer	$ui_renderer

Private Member Functions
	showSubTabs ()

	updateState ()

	updateRelationState (int $user, string $action)

	asErrorMessage (array $array, string $title)

	inviteToChatForm (array $options, array $usr_ids)

	chatroomInvitationMessage ()

	contactAction ()

Private Attributes
readonly ILIAS HTTP GlobalHttpState	$http

readonly RelationsTable	$relations_table

array	$view_mode_options

Detailed Description

Author: Jens Conze

ilContactGUI: ilMailSearchCoursesGUI, ilMailSearchGroupsGUI, ilMailSearchLearningSequenceGUI, ilMailingListsGUI ilContactGUI: ilUsersGalleryGUI, ilPublicUserProfileGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilContactGUI::__construct	(	string	$format_mail_class = `ilFormatMail::class`,
		string	$relations_table_class = `RelationsTable::class`
	)

Definition at line 61 of file class.ilContactGUI.php.

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

       {
         global $DIC;
 
         $this->tpl = $DIC['tpl'];
         $this->ctrl = $DIC['ilCtrl'];
         $this->lng = $DIC['lng'];
         $this->tabs_gui = $DIC['ilTabs'];
         $this->help = $DIC['ilHelp'];
         $this->toolbar = $DIC['ilToolbar'];
         $this->user = $DIC['ilUser'];
         $this->error = $DIC['ilErr'];
         $this->rbacsystem = $DIC['rbacsystem'];
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
         $this->ui_factory = $DIC->ui()->factory();
         $this->ui_renderer = $DIC->ui()->renderer();
 
         $this->ctrl->saveParameter($this, "mobj_id");
 
         $this->umail = new $format_mail_class($this->user->getId());
         $this->relations_table = new $relations_table_class(
             $this->ui_factory,
             $this->lng,
             $DIC->uiService(),
             $this->http
         );
         $this->lng->loadLanguageModule('buddysystem');
     }

Here is the call graph for this function:

Member Function Documentation

◆ activateTab()

ilContactGUI::activateTab ( string $a_id )

protected

Definition at line 274 of file class.ilContactGUI.php.

Referenced by executeCommand(), inviteToChat(), and showContacts().

                                                 : void
     {
         if ($this->has_sub_tabs) {
             $this->tabs_gui->activateSubTab($a_id);
         } else {
             $this->tabs_gui->activateTab($a_id);
         }
     }

Here is the caller graph for this function:

◆ asErrorMessage()

ilContactGUI::asErrorMessage	(	array	$array,
		string	$title
	)

private

Parameters

list<string|int> $array

Definition at line 534 of file class.ilContactGUI.php.

Referenced by submitInvitation().

                                                                 : string
     {
         if ($array === []) {
             return '';
         }
 
         $items = array_map(
             fn($s) => '<li>' . htmlspecialchars((string) $s) . '</li>',
             $array
         );
 
         return sprintf(
             '%s<br><ul>%s</ul>',
             $title,
             join('', $items)
         );
     }

Here is the caller graph for this function:

◆ changeContactsView()

ilContactGUI::changeContactsView ( )

protected

This method is used to switch the contacts view between gallery and table in the mail system.

Definition at line 286 of file class.ilContactGUI.php.

References ILIAS\Repository\ctrl(), ilBuddySystem\getInstance(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

                                            : void
     {
         if (!ilBuddySystem::getInstance()->isEnabled()) {
             $this->error->raiseError($this->lng->txt('msg_no_perm_read'), $this->error->MESSAGE);
         }
 
         $contacts_view = $this->http->wrapper()->query()->retrieve(
             'contacts_view',
             $this->refinery->byTrying([
                 $this->refinery->kindlyTo()->string(),
                 $this->refinery->always(self::CONTACTS_VIEW_TABLE)
             ])
         );
 
         switch ($contacts_view) {
             case self::CONTACTS_VIEW_GALLERY:
                 $this->ctrl->redirectByClass(ilUsersGalleryGUI::class);
 
                 // no break
             case self::CONTACTS_VIEW_TABLE:
             default:
                 $this->ctrl->redirect($this);
         }
     }

Here is the call graph for this function:

◆ chatroomInvitationMessage()

ilContactGUI::chatroomInvitationMessage ( )

private

Returns: Component[]

Definition at line 578 of file class.ilContactGUI.php.

References Vendor\Package\$a, $url, ilLink\_getStaticLink(), ilObjUser\_lookupLogin(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Referenced by showContacts().

                                                 : array
     {
         $has = $this->http->wrapper()->query()->has(...);
         if (!$has('inv_room_ref_id') || !$has('inv_usr_ids')) {
             return [];
         }
 
         $inv_room_ref_id = $this->http->wrapper()->query()->retrieve(
             'inv_room_ref_id',
             $this->refinery->kindlyTo()->int()
         );
         $inv_usr_ids = $this->http->wrapper()->query()->retrieve(
             'inv_usr_ids',
             $this->refinery->in()->series([
                 $this->refinery->kindlyTo()->string(),
                 $this->refinery->custom()->transformation(fn(string $s): array => explode(',', $s)),
                 $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int()),
                 $this->refinery->custom()->constraint(fn(array $a): bool => $a !== [], fn(): string => 'Empty array.'),
             ])
         );
 
         $userlist = array_map(ilObjUser::_lookupLogin(...), $inv_usr_ids);
 
         $url = ilLink::_getStaticLink($inv_room_ref_id, 'chtr');
 
         return [
             $this->ui_factory->messageBox()->success(
                 $this->lng->txt('chat_users_have_been_invited') . $this->ui_renderer->render(
                     $this->ui_factory->listing()->unordered($userlist)
                 )
             )->withButtons([
                 $this->ui_factory->button()->standard($this->lng->txt('goto_invitation_chat'), $url)
             ])
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ contactAction()

ilContactGUI::contactAction ( )

private

Returns: Closure(string, string, string): Action

Definition at line 617 of file class.ilContactGUI.php.

References $param, $token, $url, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by showContacts().

                                     : Closure
     {
         $url = new URLBuilder(new URI(rtrim(ILIAS_HTTP_PATH, '/') . '/' . $this->ctrl->getLinkTarget($this, 'updateState')));
         [$url, $p, $token] = $url->acquireParameters(['contact'], 'action', 'user_ids');
 
         return fn(string $type, string $lang_var, string $param): Action => $this->ui_factory->table()->action()->$type(
             $this->lng->txt($lang_var),
             $url->withParameter($p, $param),
             $token
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilContactGUI::executeCommand ( )

Definition at line 93 of file class.ilContactGUI.php.

References activateTab(), ILIAS\Repository\ctrl(), ilBuddySystem\getInstance(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), showSubTabs(), and ILIAS\Repository\user().

                                     : bool
     {
         $this->showSubTabs();
 
         $forward_class = $this->ctrl->getNextClass($this) ?? '';
 
         $this->umail->persistToStage($this->user->getId(), [], '', '', '', '', '', false);
 
         switch (strtolower($forward_class)) {
             case strtolower(ilMailSearchCoursesGUI::class):
                 $this->activateTab('mail_my_courses');
 
                 $this->ctrl->setReturn($this, "showContacts");
                 $this->ctrl->forwardCommand(new ilMailSearchCoursesGUI());
                 break;
 
             case strtolower(ilMailSearchGroupsGUI::class):
                 $this->activateTab('mail_my_groups');
 
                 $this->ctrl->setReturn($this, "showContacts");
                 $this->ctrl->forwardCommand(new ilMailSearchGroupsGUI());
                 break;
 
             case strtolower(ilMailingListsGUI::class):
                 $this->activateTab('mail_my_mailing_lists');
 
                 $this->ctrl->setReturn($this, "showContacts");
                 $this->ctrl->forwardCommand(new ilMailingListsGUI());
                 break;
 
             case strtolower(ilUsersGalleryGUI::class):
                 if (!ilBuddySystem::getInstance()->isEnabled()) {
                     $this->error->raiseError($this->lng->txt('msg_no_perm_read'), $this->error->MESSAGE);
                 }
 
                 $this->tabs_gui->activateSubTab('buddy_view_gallery');
                 $this->activateTab('my_contacts');
                 $this->ctrl->forwardCommand(new ilUsersGalleryGUI(new ilUsersGalleryContacts()));
                 $this->tpl->printToStdout();
                 break;
 
             case strtolower(ilPublicUserProfileGUI::class):
                 $profile_gui = new ilPublicUserProfileGUI(
                     $this->http->wrapper()->query()->retrieve('user', $this->refinery->kindlyTo()->int())
                 );
                 $profile_gui->setBackUrl($this->ctrl->getLinkTarget($this, 'showContacts'));
                 $this->ctrl->forwardCommand($profile_gui);
                 $this->tpl->printToStdout();
                 break;
 
             default:
                 $this->activateTab('mail_my_entries');
 
                 if (!($cmd = $this->ctrl->getCmd())) {
                     if (ilBuddySystem::getInstance()->isEnabled()) {
                         $cmd = 'showContacts';
                     } else {
                         $this->ctrl->redirectByClass(ilMailSearchCoursesGUI::class);
                     }
                 }
 
                 $this->$cmd();
                 break;
         }
         return true;
     }

Here is the call graph for this function:

◆ inviteToChat()

ilContactGUI::inviteToChat ( array $usr_ids )

protected

Parameters

non-empty-array<int> $usr_ids

Definition at line 509 of file class.ilContactGUI.php.

References activateTab(), ilChatroom\byRoomId(), inviteToChatForm(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Referenced by submitInvitation().

                                                    : void
     {
         $this->tabs_gui->activateSubTab('buddy_view_table');
         $this->activateTab('my_contacts');
 
         $this->lng->loadLanguageModule('chatroom');
 
         $chat_rooms = (new ilChatroom())->getAccessibleRoomIdByTitleMap($this->user->getId());
 
         $options = array_filter(
             $chat_rooms,
             fn(int $room_id) => !(ilChatroom::byRoomId($room_id))->isUserBanned($this->user->getId()),
             ARRAY_FILTER_USE_KEY
         );
 
         asort($options);
 
         $this->tpl->setTitle($this->lng->txt('mail_invite_users_to_chat'));
         $this->tpl->setContent($this->inviteToChatForm($options, $usr_ids)->getHTML());
         $this->tpl->printToStdout();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ inviteToChatForm()

ilContactGUI::inviteToChatForm	(	array	$options,
		array	$usr_ids
	)

private

Parameters

array<string,string>	$options
list<int>	$usr_ids

Definition at line 556 of file class.ilContactGUI.php.

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

Referenced by inviteToChat().

                                                                      : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
         $form->setTitle($this->lng->txt('mail_invite_users_to_chat'));
         $form->addCommandButton('submitInvitation', $this->lng->txt('submit'));
         $form->addCommandButton('showContacts', $this->lng->txt('cancel'));
         $form->setFormAction($this->ctrl->getFormAction($this, 'showContacts'));
 
         $sel = new ilSelectInputGUI($this->lng->txt('chat_select_room'), 'room_id');
         $sel->setOptions($options);
         $form->addItem($sel);
 
         $hidden = new ilHiddenInputGUI('usr_ids');
         $hidden->setValue(implode(',', $usr_ids));
         $form->addItem($hidden);
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mailToUsers()

ilContactGUI::mailToUsers ( array $usr_ids )

protected

Parameters

non-empty-array<int> $usr_ids

Definition at line 402 of file class.ilContactGUI.php.

References ilObjUser\_lookupLogin(), ILIAS\Repository\ctrl(), ilMailGlobalServices\getMailObjectRefId(), and ILIAS\Repository\lng().

                                                   : void
     {
         if (!$this->rbacsystem->checkAccess('internal_mail', ilMailGlobalServices::getMailObjectRefId())) {
             $this->error->raiseError($this->lng->txt('msg_no_perm_read'), $this->error->MESSAGE);
         }
 
         $logins = [];
         $mail_data = $this->umail->retrieveFromStage();
         foreach ($usr_ids as $usr_id) {
             $login = ilObjUser::_lookupLogin($usr_id);
             if (!$this->umail->existsRecipient($login, (string) $mail_data['rcp_to'])) {
                 $logins[] = $login;
             }
         }
         $logins = array_filter($logins);
 
         if ($logins !== []) {
             $mail_data = $this->umail->appendSearchResult($logins, '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']
             );
         }
 
         $this->ctrl->redirectToURL('ilias.php?baseClass=ilMailGUI&type=search_res');
     }

Here is the call graph for this function:

◆ showContacts()

ilContactGUI::showContacts ( )

protected

Definition at line 311 of file class.ilContactGUI.php.

References activateTab(), chatroomInvitationMessage(), contactAction(), ILIAS\Repository\ctrl(), ilBuddySystem\getInstance(), ilMailGlobalServices\getMailObjectRefId(), and ILIAS\Repository\lng().

                                      : void
     {
         if (!ilBuddySystem::getInstance()->isEnabled()) {
             $this->error->raiseError($this->lng->txt('msg_no_perm_read'), $this->error->MESSAGE);
         }
 
         $this->tabs_gui->activateSubTab('buddy_view_table');
         $this->activateTab('my_contacts');
 
         $content = $this->chatroomInvitationMessage();
         $action = $this->contactAction();
         $chat_allowed = (bool) (new ilSetting('chatroom'))->get('chat_enabled', '0');
         $mail_allowed = $this->rbacsystem->checkAccess(
             'internal_mail',
             ilMailGlobalServices::getMailObjectRefId()
         );
 
         $content = array_merge($content, $this->relations_table->build(array_merge(
             $chat_allowed ? ['chat' => $action('standard', 'invite_to_chat', 'inviteToChat')] : [],
             $mail_allowed ? ['mail' => $action('standard', 'send_mail', 'mailToUsers')] : [],
         ), $this->ctrl->getLinkTarget($this, 'showContacts'), $action));
 
         $this->tpl->setContent($this->ui_renderer->render($content));
         $this->tpl->printToStdout();
     }

Here is the call graph for this function:

◆ showSubTabs()

ilContactGUI::showSubTabs ( )

private

Definition at line 161 of file class.ilContactGUI.php.

References $url, ILIAS\Repository\ctrl(), ilUtil\getImagePath(), ilBuddySystem\getInstance(), ilBuddyList\getInstanceByGlobalUser(), ILIAS\Repository\help(), ILIAS\Repository\lng(), null, ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Referenced by executeCommand().

                                   : void
     {
         $galleryCmdClasses = array_map('strtolower', [ilUsersGalleryGUI::class, self::class]);
         if ($this->tabs_gui->hasTabs()) {
             if (ilBuddySystem::getInstance()->isEnabled()) {
                 $this->tabs_gui->addSubTab(
                     'my_contacts',
                     $this->lng->txt('my_contacts'),
                     $this->ctrl->getLinkTarget($this)
                 );
 
                 if (in_array(strtolower($this->ctrl->getCmdClass() ?? ''), $galleryCmdClasses, true)) {
                     $mode_options = array_combine(
                         array_map(
                             fn(string $mode): string => $this->lng->txt($mode),
                             array_keys($this->view_mode_options)
                         ),
                         array_map(
                             function (string $mode): string {
                                 $this->ctrl->setParameter($this, 'contacts_view', $mode);
                                 $url = $this->ctrl->getFormAction($this, 'changeContactsView');
                                 $this->ctrl->setParameter($this, 'contacts_view', null);
 
                                 return $url;
                             },
                             array_keys($this->view_mode_options)
                         ),
                     );
 
                     $active_mode = strtolower($this->ctrl->getCmdClass() ?? '') === strtolower(ilUsersGalleryGUI::class)
                         ? self::CONTACTS_VIEW_GALLERY
                         : self::CONTACTS_VIEW_TABLE;
 
                     $sortViewControl = $this->ui_factory
                         ->viewControl()
                         ->mode($mode_options, $this->lng->txt($active_mode))
                         ->withActive($this->lng->txt($active_mode));
                     $this->toolbar->addComponent($sortViewControl);
                 }
 
                 if (
                     count(ilBuddyList::getInstanceByGlobalUser()->getLinkedRelations()) > 0 ||
                     (new ilMailingLists($this->user))->hasAny()
                 ) {
                     $this->tabs_gui->addSubTab(
                         'mail_my_mailing_lists',
                         $this->lng->txt('mail_my_mailing_lists'),
                         $this->ctrl->getLinkTargetByClass(ilMailingListsGUI::class)
                     );
                 }
             }
 
             $this->tabs_gui->addSubTab(
                 'mail_my_courses',
                 $this->lng->txt('mail_my_courses'),
                 $this->ctrl->getLinkTargetByClass(ilMailSearchCoursesGUI::class)
             );
             $this->tabs_gui->addSubTab(
                 'mail_my_groups',
                 $this->lng->txt('mail_my_groups'),
                 $this->ctrl->getLinkTargetByClass(ilMailSearchGroupsGUI::class)
             );
             $this->has_sub_tabs = true;
         } else {
             $this->tpl->setTitleIcon(ilUtil::getImagePath('standard/icon_cadm.svg'));
 
             $this->help->setScreenIdComponent('contacts');
 
             if (ilBuddySystem::getInstance()->isEnabled()) {
                 $this->tabs_gui->addTab(
                     'my_contacts',
                     $this->lng->txt('my_contacts'),
                     $this->ctrl->getLinkTarget($this)
                 );
 
                 if (in_array(strtolower($this->ctrl->getCmdClass() ?? ''), $galleryCmdClasses, true)) {
                     $this->tabs_gui->addSubTab(
                         'buddy_view_table',
                         $this->lng->txt('buddy_view_table'),
                         $this->ctrl->getLinkTarget($this)
                     );
                     $this->tabs_gui->addSubTab(
                         'buddy_view_gallery',
                         $this->lng->txt('buddy_view_gallery'),
                         $this->ctrl->getLinkTargetByClass(ilUsersGalleryGUI::class)
                     );
                 }
 
                 if (
                     count(ilBuddyList::getInstanceByGlobalUser()->getLinkedRelations()) > 0 ||
                     (new ilMailingLists($this->user))->hasAny()
                 ) {
                     $this->tabs_gui->addTab(
                         'mail_my_mailing_lists',
                         $this->lng->txt('mail_my_mailing_lists'),
                         $this->ctrl->getLinkTargetByClass(ilMailingListsGUI::class)
                     );
                 }
             }
 
             $this->tabs_gui->addTab(
                 'mail_my_courses',
                 $this->lng->txt('mail_my_courses'),
                 $this->ctrl->getLinkTargetByClass(ilMailSearchCoursesGUI::class)
             );
             $this->tabs_gui->addTab(
                 'mail_my_groups',
                 $this->lng->txt('mail_my_groups'),
                 $this->ctrl->getLinkTargetByClass(ilMailSearchGroupsGUI::class)
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ submitInvitation()

ilContactGUI::submitInvitation ( )

Definition at line 437 of file class.ilContactGUI.php.

References Vendor\Package\$a, $id, $message, $ref_id, ilLink\_getStaticLink(), ilObjUser\_lookupLogin(), asErrorMessage(), ilChatroom\byRoomId(), ilChatroom\checkPermissionsOfUser(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), inviteToChat(), ILIAS\Repository\lng(), null, ILIAS\Repository\refinery(), and ILIAS\Repository\user().

                                       : void
     {
         try {
             $usr_ids = $this->http->wrapper()->post()->retrieve('usr_ids', $this->refinery->in()->series([
                 $this->refinery->kindlyTo()->string(),
                 $this->refinery->custom()->transformation(fn(string $s) => explode(',', $s)),
                 $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int()),
                 $this->refinery->custom()->constraint(fn(array $a) => $a !== [], fn() => 'Empty array.'),
             ]));
         } catch (Exception) {
             $this->tpl->setOnScreenMessage('info', $this->lng->txt('select_one'), true);
             $this->ctrl->redirect($this);
         }
 
         try {
             $room_id = $this->http->wrapper()->post()->retrieve('room_id', $this->refinery->kindlyTo()->int());
         } catch (Exception) {
             $this->tpl->setOnScreenMessage('info', $this->lng->txt('select_one'));
             $this->inviteToChat($usr_ids);
             return;
         }
 
         $room = ilChatroom::byRoomId($room_id, true);
 
         $no_access = [];
         $no_login = [];
         $valid_users = [];
         $ref_id = $room->getRefIdByRoomId($room_id);
 
         foreach ($usr_ids as $usr_id) {
             $login = ilObjUser::_lookupLogin($usr_id);
             if ($login === '') {
                 $no_login[] = $usr_id;
             } elseif (
                 !ilChatroom::checkPermissionsOfUser($usr_id, 'read', $ref_id) ||
                 $room->isUserBanned($usr_id)
             ) {
                 $no_access[] = $login;
             } else {
                 $valid_users[] = $usr_id;
             }
         }
 
         $message = join('', [
             $this->asErrorMessage($no_access, $this->lng->txt('chat_users_without_permission')),
             $this->asErrorMessage($no_login, $this->lng->txt('chat_users_without_login')),
         ]);
 
         if ($message !== '') {
             $this->tpl->setOnScreenMessage('failure', $message);
             $this->inviteToChat($usr_ids);
             return;
         }
 
         foreach ($valid_users as $id) {
             $room->sendInvitationNotification(
                 null,
                 $this->user->getId(),
                 $id,
                 ilLink::_getStaticLink($ref_id, 'chtr')
             );
         }
 
         $this->ctrl->setParameter($this, 'inv_room_ref_id', $ref_id);
         $this->ctrl->setParameter($this, 'inv_usr_ids', implode(',', $valid_users));
 
         $this->ctrl->redirect($this);
     }

Here is the call graph for this function:

◆ updateRelationState()

ilContactGUI::updateRelationState	(	int	$user,
		string	$action
	)

private

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

References Vendor\Package\$e, $relation, ilObjUser\_isAnonymous(), ilObjUser\_lookupLogin(), ilObjUser\_lookupPref(), ILIAS\Repository\ctrl(), ilBuddyList\getInstanceByGlobalUser(), ILIAS\Repository\lng(), and ilUtil\yn2tf().

Referenced by updateState().

                                                                    : void
     {
         $login = ilObjUser::_lookupLogin($user);
         if (ilObjUser::_isAnonymous($user)) {
             throw new ilBuddySystemException('You cannot perform a state transition for the anonymous user');
         }
         if (!$login) {
             throw new ilBuddySystemException(sprintf(
                 'You cannot perform a state transition for a non existing user (id: %s)',
                 $user
             ));
         }
         $list = ilBuddyList::getInstanceByGlobalUser();
         $relation = $list->getRelationByUserId($user);
         if (
             $relation->isUnlinked() &&
             !ilUtil::yn2tf((string) ilObjUser::_lookupPref($relation->getBuddyUsrId(), 'bs_allow_to_contact_me'))
         ) {
             throw new ilException('The requested user does not want to get contact requests');
         }
 
         try {
             $list->$action($relation);
         } catch (ilBuddySystemRelationStateAlreadyGivenException|ilBuddySystemRelationStateTransitionException $e) {
             $this->tpl->setOnScreenMessage('failure', sprintf($this->lng->txt($e->getMessage()), $login), true);
         } catch (Exception) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('buddy_bs_action_not_possible'), true);
         }
 
         $this->ctrl->redirect($this, 'showContacts');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateState()

ilContactGUI::updateState ( )

private

Definition at line 337 of file class.ilContactGUI.php.

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

                                   : void
     {
         $get = $this->http->wrapper()->query()->retrieve(...);
 
         $user_ids = $get('contact_user_ids', $this->refinery->byTrying([
             $this->refinery->null(),
             $this->refinery->kindlyTo()->listOf($this->refinery->byTrying([
                 $this->refinery->kindlyTo()->int(),
             ])),
             $this->refinery->custom()->transformation(
                 fn($s): array => is_array($s) && join('', $s) === 'ALL_OBJECTS' ?
                     array_column(RelationsTable::data(), 'user_id') :
                     throw new Exception('Nope')
             ),
         ]));
 
         $action = $get('contact_action', $this->refinery->kindlyTo()->string());
         if (!$user_ids) {
             $this->tpl->setOnScreenMessage('info', $this->lng->txt('select_one'), true);
             $this->ctrl->redirect($this);
         }
 
         if (in_array($action, ['inviteToChat', 'mailToUsers'], true)) {
             $this->$action($user_ids);
             return;
         }
 
         $this->updateRelationState(current($user_ids), $action);
     }

Here is the call graph for this function:

Field Documentation

◆ $ctrl

ilCtrlInterface ilContactGUI::$ctrl

protected

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

◆ $error

ilErrorHandling ilContactGUI::$error

protected

Definition at line 48 of file class.ilContactGUI.php.

◆ $has_sub_tabs

bool ilContactGUI::$has_sub_tabs = false

protected

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

◆ $help

ilHelpGUI ilContactGUI::$help

protected

Definition at line 44 of file class.ilContactGUI.php.

◆ $http

readonly ILIAS HTTP GlobalHttpState ilContactGUI::$http

private

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

Referenced by __construct().

◆ $lng

ilLanguage ilContactGUI::$lng

protected

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

◆ $rbacsystem

ilRbacSystem ilContactGUI::$rbacsystem

protected

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

◆ $refinery

Refinery ilContactGUI::$refinery

protected

Definition at line 51 of file class.ilContactGUI.php.

◆ $relations_table

readonly RelationsTable ilContactGUI::$relations_table

private

Definition at line 54 of file class.ilContactGUI.php.

◆ $tabs_gui

ilTabsGUI ilContactGUI::$tabs_gui

protected

Definition at line 43 of file class.ilContactGUI.php.

◆ $toolbar

ilToolbarGUI ilContactGUI::$toolbar

protected

Definition at line 45 of file class.ilContactGUI.php.

◆ $tpl

ilGlobalTemplateInterface ilContactGUI::$tpl

protected

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

◆ $ui_factory

ILIAS UI Factory ilContactGUI::$ui_factory

protected

Definition at line 52 of file class.ilContactGUI.php.

◆ $ui_renderer

ILIAS UI Renderer ilContactGUI::$ui_renderer

protected

Definition at line 53 of file class.ilContactGUI.php.

◆ $umail

ilFormatMail ilContactGUI::$umail

protected

Definition at line 46 of file class.ilContactGUI.php.

◆ $user

ilObjUser ilContactGUI::$user

protected

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

◆ $view_mode_options

array ilContactGUI::$view_mode_options

private

Initial value:

= [

self::CONTACTS_VIEW_TABLE => self::CONTACTS_VIEW_TABLE

Definition at line 56 of file class.ilContactGUI.php.

◆ CONTACTS_VIEW_GALLERY

final const string ilContactGUI::CONTACTS_VIEW_GALLERY = 'buddy_view_gallery'

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

◆ CONTACTS_VIEW_TABLE

final const string ilContactGUI::CONTACTS_VIEW_TABLE = 'buddy_view_table'

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

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

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activateTab()

◆ asErrorMessage()

◆ changeContactsView()

◆ chatroomInvitationMessage()

◆ contactAction()

◆ executeCommand()

◆ inviteToChat()

◆ inviteToChatForm()

◆ mailToUsers()

◆ showContacts()

◆ showSubTabs()

◆ submitInvitation()

◆ updateRelationState()

◆ updateState()

Field Documentation

◆ $ctrl

◆ $error

◆ $has_sub_tabs

◆ $help

◆ $http

◆ $lng

◆ $rbacsystem

◆ $refinery

◆ $relations_table

◆ $tabs_gui

◆ $toolbar

◆ $tpl

◆ $ui_factory

◆ $ui_renderer

◆ $umail

◆ $user

◆ $view_mode_options

◆ CONTACTS_VIEW_GALLERY

◆ CONTACTS_VIEW_TABLE