Inheritance diagram for ilMailSearchObjectGUI:

Collaboration diagram for ilMailSearchObjectGUI:

Public Member Functions
	__construct (protected readonly ilPortfolioAccessHandler\|ilWorkspaceAccessHandler\|null $wsp_access_handler=null, protected readonly ?int $wsp_node_id=null,)

	getObjectType ()

	getObjectTypeLabel ()

	getSearchTableTitle ()

	doesExposeMembers (ilObject $object)

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

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

	executeCommand ()

	getContext ()

	isDefaultRequestContext ()

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

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

Data Fields
const string	CONTEXT_CONTACT = 'contact'

const string	CONTEXT_MAIL = 'mail'

const string	CONTEXT_WORKSPACE = 'wsp'

const string	CMD_SHOW_MY_OBJECTS = 'showMyObjects'

const string	CMD_HANDLE_MAIL_SEARCH_OBJECT_ACTIONS = 'handleMailSearchObjectActions'

const string	CMD_CANCEL = 'cancel'

const string	ACTION_MAIL_OBJECTS = 'mailObjects'

const string	ACTION_MAIL_MEMBERS = 'mailMembers'

const string	ACTION_SHARE_OBJECTS = 'shareObjects'

const string	ACTION_SHARE_MEMBERS = 'shareMembers'

const string	ACTION_SHOW_MEMBERS = 'showMembers'

const string	ACTION_BUDDY_REQUEST = 'buddyRequest'

Protected Member Functions
	getLocalDefaultRolePrefixes ()

	addPermission (array $a_obj_ids)

Protected Attributes
readonly GlobalHttpState	$http

readonly Refinery	$refinery

readonly ilGlobalTemplateInterface	$tpl

readonly ilCtrlInterface	$ctrl

readonly ilLanguage	$lng

readonly ilObjUser	$user

readonly ilErrorHandling	$error

readonly ilRbacSystem	$rbacsystem

readonly ilRbacReview	$rbacreview

readonly ilTree	$tree

readonly ilObjectDataCache	$cache

readonly ilFormatMail	$umail

readonly bool	$mailing_allowed

readonly Factory	$ui_factory

readonly Renderer	$ui_renderer

Private Member Functions
	mailMembers ()

	cancel ()

	showMyObjects ()

	isLocalRoleTitle (string $title)

	shareObjects ()

	shareMembers ()

	mailObjects ()

	handleMailSearchObjectActions ()

	isMailActionAllowed ()

	isShareActionAllowed ()

	resolveBuddyUserIdFromQuery ()

	retrieveObjectIdsFromQuery ()

	resolveObjectIds (array\|string $obj_ids)

	getOwnObjectIds ()

	resolveUserIds ()

	collectMemberRowIds (array $obj_ids)

	retrieveMemberRowIdsFromQuery ()

	retrieveIdsFromQuery (string $key)

Private Attributes
readonly ilTabsGUI	$tabs

string	$context = null

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilMailSearchObjectGUI::__construct	(	protected readonly ilPortfolioAccessHandler\|ilWorkspaceAccessHandler\|null	$wsp_access_handler = `null`,
		protected readonly ?int	$wsp_node_id = `null`
	)

Exceptions

ilCtrlException

Definition at line 63 of file class.ilMailSearchObjectGUI.php.

      {
        global $DIC;
 
        $this->tpl = $DIC['tpl'];
        $this->ctrl = $DIC['ilCtrl'];
        $this->lng = $DIC['lng'];
        $this->user = $DIC['ilUser'];
        $this->error = $DIC['ilErr'];
        $this->rbacsystem = $DIC['rbacsystem'];
        $this->rbacreview = $DIC['rbacreview'];
        $this->tree = $DIC['tree'];
        $this->cache = $DIC['ilObjDataCache'];
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->tabs = $DIC->tabs();
 
        $this->ctrl->saveParameter($this, 'mobj_id');
        $this->ctrl->saveParameter($this, 'ref');
 
        $this->mailing_allowed = $this->rbacsystem->checkAccess(
            'internal_mail',
            new ilMail($this->user->getId())->getMailObjectReferenceId(),
        );
 
        $this->umail = new ilFormatMail($this->user->getId());
 
        $this->lng->loadLanguageModule('mail');
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ addPermission()

ilMailSearchObjectGUI::addPermission ( array $a_obj_ids )

protected

Parameters

int[] $a_obj_ids

Definition at line 190 of file class.ilMailSearchObjectGUI.php.

                                                      : void
    {
        if ($this->wsp_access_handler === null || $this->wsp_node_id === null) {
            $this->error->raiseError($this->lng->txt('msg_no_perm_read'), $this->error->MESSAGE);
        }
 
        $added = $this->wsp_access_handler->addMissingPermissionForObjects($this->wsp_node_id, $a_obj_ids);
 
        if ($added) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('wsp_share_success'), true);
        }
        $this->ctrl->redirectByClass(ilWorkspaceAccessGUI::class, 'share');
    }

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

Referenced by shareMembers(), and shareObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cancel()

ilMailSearchObjectGUI::cancel ( )

private

Definition at line 244 of file class.ilMailSearchObjectGUI.php.

                             : void
    {
        $view = '';
        if ($this->http->wrapper()->query()->has('view')) {
            $view = $this->http->wrapper()->query()->retrieve('view', $this->refinery->kindlyTo()->string());
        }
 
        if ($view === 'myobjects' && $this->isDefaultRequestContext()) {
            $this->ctrl->returnToParent($this);
        } else {
            $this->showMyObjects();
        }
    }

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ collectMemberRowIds()

ilMailSearchObjectGUI::collectMemberRowIds ( array $obj_ids )

private

Parameters

list<int> $obj_ids

Returns: list<string>

Definition at line 649 of file class.ilMailSearchObjectGUI.php.

                                                        : array
    {
        $member_row_ids = [];
        foreach ($obj_ids as $obj_id) {
            $ref_ids = new ObjectId($obj_id)->toReferenceIds();
            if ($ref_ids === []) {
                continue;
            }
 
            foreach (ilParticipants::getInstance($ref_ids[0]->toInt())->getParticipants() as $participant) {
                if (ilObjUser::_lookupActive($participant)) {
                    $member_row_ids[] = "{$obj_id}_$participant";
                }
            }
        }
 
        return $member_row_ids;
    }

References ilObjUser\_lookupActive(), ilParticipants\getInstance(), and ILIAS\Data\ObjectId\toReferenceIds().

Referenced by resolveUserIds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doesExposeMembers()

ilMailSearchObjectGUI::doesExposeMembers ( ilObject $object )

abstract

Reimplemented in ilMailSearchCoursesGUI, and ilMailSearchGroupsGUI.

◆ executeCommand()

ilMailSearchObjectGUI::executeCommand ( )

Exceptions

ilCtrlException

Definition at line 125 of file class.ilMailSearchObjectGUI.php.

                                    : bool
    {
        $forward_class = $this->ctrl->getNextClass($this) ?? '';
        switch (strtolower($forward_class)) {
            case strtolower(ilBuddySystemGUI::class):
                if (!ilBuddySystem::getInstance()->isEnabled()) {
                    $this->error->raiseError($this->lng->txt('msg_no_perm_read'), $this->error->MESSAGE);
                }
 
                $buddy_user_id = $this->resolveBuddyUserIdFromQuery();
                if ($buddy_user_id !== null) {
                    $this->ctrl->setParameterByClass(ilBuddySystemGUI::class, 'user_id', $buddy_user_id);
                }
 
                $obj_ids = $this->retrieveObjectIdsFromQuery();
                $this->ctrl->setParameter($this, 'contact_mailinglist_search_action', self::ACTION_SHOW_MEMBERS);
                if ($obj_ids !== []) {
                    $this->ctrl->setParameter(
                        $this,
                        'contact_mailinglist_search_obj_ids',
                        implode(',', $obj_ids)
                    );
                }
                $this->ctrl->setReturn($this, self::CMD_HANDLE_MAIL_SEARCH_OBJECT_ACTIONS);
                $this->ctrl->forwardCommand(new ilBuddySystemGUI());
                break;
 
            default:
                match ($this->ctrl->getCmd()) {
                    self::CMD_HANDLE_MAIL_SEARCH_OBJECT_ACTIONS => $this->handleMailSearchObjectActions(),
                    self::CMD_CANCEL => $this->cancel(),
                    default => $this->showMyObjects(),
                };
                break;
        }
 
        return true;
    }

References cancel(), ILIAS\Repository\ctrl(), ilBuddySystem\getInstance(), handleMailSearchObjectActions(), ILIAS\Repository\lng(), resolveBuddyUserIdFromQuery(), retrieveObjectIdsFromQuery(), and showMyObjects().

Here is the call graph for this function:

◆ getContext()

ilMailSearchObjectGUI::getContext ( )

Definition at line 164 of file class.ilMailSearchObjectGUI.php.

                                : string
    {
        if ($this->context === null) {
            $context = $this->http->wrapper()->query()->retrieve(
                'ref',
                $this->refinery->byTrying([
                    $this->refinery->kindlyTo()->string(),
                    $this->refinery->always(self::CONTEXT_CONTACT)
                ]),
            );
            $this->context = in_array($context, [self::CONTEXT_CONTACT, self::CONTEXT_MAIL, self::CONTEXT_WORKSPACE], true)
                ? $context
                : self::CONTEXT_CONTACT;
        }
 
        return $this->context;
    }

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

Referenced by isDefaultRequestContext(), isShareActionAllowed(), and showMyObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLocalDefaultRolePrefixes()

ilMailSearchObjectGUI::getLocalDefaultRolePrefixes ( )

abstractprotected

Returns: string[] Returns an array like ['il_crs_member_', 'il_crs_tutor', ...]

Reimplemented in ilMailSearchCoursesGUI, and ilMailSearchGroupsGUI.

Referenced by isLocalRoleTitle().

Here is the caller graph for this function:

◆ getObjectType()

ilMailSearchObjectGUI::getObjectType ( )

abstract

Reimplemented in ilMailSearchCoursesGUI, and ilMailSearchGroupsGUI.

Referenced by retrieveObjectIdsFromQuery().

Here is the caller graph for this function:

◆ getObjectTypeLabel()

ilMailSearchObjectGUI::getObjectTypeLabel ( )

abstract

Reimplemented in ilMailSearchCoursesGUI, and ilMailSearchGroupsGUI.

◆ getOwnObjectIds()

ilMailSearchObjectGUI::getOwnObjectIds ( )

private

Returns: list<int>

Definition at line 607 of file class.ilMailSearchObjectGUI.php.

                                      : array
    {
        return array_values(array_filter(
            ilParticipants::_getMembershipByType($this->user->getId(), [$this->getObjectType()]),
            ilObject::_hasUntrashedReference(...),
        ));
    }

References ilParticipants\_getMembershipByType(), ilObject\_hasUntrashedReference(), and ILIAS\Repository\user().

Referenced by resolveObjectIds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSafePostCommands()

ilMailSearchObjectGUI::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 117 of file class.ilMailSearchObjectGUI.php.

                                         : array
    {
        return [];
    }

◆ getSearchTableTitle()

ilMailSearchObjectGUI::getSearchTableTitle ( )

abstract

Reimplemented in ilMailSearchCoursesGUI, and ilMailSearchGroupsGUI.

◆ getUnsafeGetCommands()

ilMailSearchObjectGUI::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 110 of file class.ilMailSearchObjectGUI.php.

                                          : array
    {
        return [
            self::CMD_HANDLE_MAIL_SEARCH_OBJECT_ACTIONS,
        ];
    }

References CMD_HANDLE_MAIL_SEARCH_OBJECT_ACTIONS.

◆ handleMailSearchObjectActions()

ilMailSearchObjectGUI::handleMailSearchObjectActions ( )

private

Definition at line 507 of file class.ilMailSearchObjectGUI.php.

                                                    : void
    {
        $query = $this->http->wrapper()->query();
 
        if (!$query->has('contact_mailinglist_search_action')) {
            $this->ctrl->redirect($this, self::CMD_SHOW_MY_OBJECTS);
            return;
        }
 
        $action = $query->retrieve('contact_mailinglist_search_action', $this->refinery->to()->string());
 
        if (
            in_array($action, [self::ACTION_MAIL_OBJECTS, self::ACTION_MAIL_MEMBERS], true)
            && !$this->isMailActionAllowed()
        ) {
            $this->error->raiseError($this->lng->txt('msg_no_perm_read'), $this->error->MESSAGE);
        }
 
        if (
            in_array($action, [self::ACTION_SHARE_OBJECTS, self::ACTION_SHARE_MEMBERS], true)
            && !$this->isShareActionAllowed()
        ) {
            $this->error->raiseError($this->lng->txt('msg_no_perm_read'), $this->error->MESSAGE);
        }
 
        match ($action) {
            self::ACTION_MAIL_OBJECTS => $this->mailObjects(),
            self::ACTION_MAIL_MEMBERS => $this->mailMembers(),
            self::ACTION_SHARE_OBJECTS => $this->shareObjects(),
            self::ACTION_SHARE_MEMBERS => $this->shareMembers(),
            self::ACTION_SHOW_MEMBERS => $this->showMembers(),
            default => $this->ctrl->redirect($this, self::CMD_SHOW_MY_OBJECTS),
        };
    }

References ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), isMailActionAllowed(), isShareActionAllowed(), ILIAS\Repository\lng(), mailMembers(), mailObjects(), ILIAS\Repository\refinery(), shareMembers(), and shareObjects().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isDefaultRequestContext()

ilMailSearchObjectGUI::isDefaultRequestContext ( )

Definition at line 182 of file class.ilMailSearchObjectGUI.php.

                                             : bool
    {
        return in_array($this->getContext(), [self::CONTEXT_CONTACT, self::CONTEXT_MAIL], true);
    }

References getContext().

Referenced by cancel(), isMailActionAllowed(), and showMyObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isLocalRoleTitle()

ilMailSearchObjectGUI::isLocalRoleTitle ( string $title )

private

Definition at line 404 of file class.ilMailSearchObjectGUI.php.

                                                    : bool
    {
        return array_any(
            $this->getLocalDefaultRolePrefixes(),
            static fn(string $local_role_prefix): bool => str_starts_with($title, $local_role_prefix),
        );
    }

References getLocalDefaultRolePrefixes().

Referenced by mailObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isMailActionAllowed()

ilMailSearchObjectGUI::isMailActionAllowed ( )

private

Definition at line 542 of file class.ilMailSearchObjectGUI.php.

                                          : bool
    {
        return $this->isDefaultRequestContext() && $this->mailing_allowed;
    }

References $mailing_allowed, and isDefaultRequestContext().

Referenced by handleMailSearchObjectActions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isShareActionAllowed()

ilMailSearchObjectGUI::isShareActionAllowed ( )

private

Definition at line 547 of file class.ilMailSearchObjectGUI.php.

                                           : bool
    {
        return $this->getContext() === self::CONTEXT_WORKSPACE
            && $this->wsp_access_handler !== null
            && $this->wsp_node_id !== null;
    }

References getContext().

Referenced by handleMailSearchObjectActions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mailMembers()

ilMailSearchObjectGUI::mailMembers ( )

private

Definition at line 204 of file class.ilMailSearchObjectGUI.php.

                                  : void
    {
        $members = [];
 
        $usr_ids = $this->resolveUserIds();
 
        if ($usr_ids === []) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_select_one_entry'));
            $this->showMembers();
 
            return;
        }
 
        $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'])) {
                $members[] = $login;
            }
        }
 
        $mail_data = $this->umail->appendSearchResult(array_unique($members), 'to');
 
        $this->umail->persistToStage(
            (int) $mail_data['user_id'],
            $mail_data['rcp_to'],
            $mail_data['rcp_cc'],
            $mail_data['rcp_bcc'],
            $mail_data['m_subject'],
            $mail_data['m_message'],
            $mail_data['attachments'],
            $mail_data['use_placeholders'],
            $mail_data['tpl_ctx_id'],
            $mail_data['tpl_ctx_params']
        );
 
        $this->ctrl->setParameterByClass(ilMailGUI::class, 'type', ilMailFormGUI::MAIL_FORM_TYPE_SEARCH_RESULT);
        $this->ctrl->redirectByClass(ilMailGUI::class);
    }

References ilObjUser\_lookupLogin(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilMailFormGUI\MAIL_FORM_TYPE_SEARCH_RESULT, and resolveUserIds().

Referenced by handleMailSearchObjectActions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mailObjects()

ilMailSearchObjectGUI::mailObjects ( )

private

Definition at line 441 of file class.ilMailSearchObjectGUI.php.

                                  : void
    {
        $members = [];
        $mail_data = $this->umail->retrieveFromStage();
 
        $obj_ids = $this->resolveObjectIds(
            $this->retrieveIdsFromQuery('contact_mailinglist_search_obj_ids')
        );
 
        if ($obj_ids === []) {
            $this->tpl->setOnScreenMessage(
                'info',
                $this->lng->txt($this->getObjectType() === 'crs' ? 'mail_select_crs' : 'mail_select_grp'),
            );
            $this->showMyObjects();
 
            return;
        }
 
        foreach ($obj_ids as $obj_id) {
            $ref_ids = ilObject::_getAllReferences($obj_id);
            foreach ($ref_ids as $ref_id) {
                $can_send_mails = ilParticipants::canSendMailToMembers(
                    $ref_id,
                    $this->user->getId(),
                    ilMailGlobalServices::getMailObjectRefId()
                );
 
                if (!$can_send_mails) {
                    continue;
                }
 
                $roles = $this->rbacreview->getAssignableChildRoles($ref_id);
                foreach ($roles as $role) {
                    if ($this->isLocalRoleTitle($role['title'])) {
                        $recipient = new ilRoleMailboxAddress($role['obj_id'])->value();
                        if (!$this->umail->existsRecipient($recipient, (string) $mail_data['rcp_to'])) {
                            $members[] = $recipient;
                        }
                    }
                }
            }
        }
 
        $mail_data = $members !== [] ? $this->umail->appendSearchResult(
            array_unique($members),
            'to'
        ) : $this->umail->retrieveFromStage();
 
        $this->umail->persistToStage(
            (int) $mail_data['user_id'],
            $mail_data['rcp_to'],
            $mail_data['rcp_cc'],
            $mail_data['rcp_bcc'],
            $mail_data['m_subject'],
            $mail_data['m_message'],
            $mail_data['attachments'],
            $mail_data['use_placeholders'],
            $mail_data['tpl_ctx_id'],
            $mail_data['tpl_ctx_params']
        );
 
        $this->ctrl->setParameterByClass(ilMailGUI::class, 'type', ilMailFormGUI::MAIL_FORM_TYPE_SEARCH_RESULT);
        $this->ctrl->redirectByClass(ilMailGUI::class);
    }

References ilObject\_getAllReferences(), ilParticipants\canSendMailToMembers(), ILIAS\Repository\ctrl(), ilMailGlobalServices\getMailObjectRefId(), isLocalRoleTitle(), ILIAS\Repository\lng(), ilMailFormGUI\MAIL_FORM_TYPE_SEARCH_RESULT, resolveObjectIds(), retrieveIdsFromQuery(), showMyObjects(), ILIAS\Repository\user(), and ilRoleMailboxAddress\value().

Referenced by handleMailSearchObjectActions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resolveBuddyUserIdFromQuery()

ilMailSearchObjectGUI::resolveBuddyUserIdFromQuery ( )

private

Definition at line 554 of file class.ilMailSearchObjectGUI.php.

                                                  : ?int
    {
        $member_row_ids = $this->retrieveMemberRowIdsFromQuery();
 
        if ($member_row_ids === 'ALL_OBJECTS' || $member_row_ids === []) {
            return null;
        }
 
        $member_row_id = is_array($member_row_ids)
            ? (string) ($member_row_ids[0] ?? '')
            : $member_row_ids;
 
        if (!str_contains($member_row_id, '_')) {
            return null;
        }
 
        return (int) explode('_', $member_row_id, 2)[1];
    }

References retrieveMemberRowIdsFromQuery().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resolveObjectIds()

ilMailSearchObjectGUI::resolveObjectIds ( array|string $obj_ids )

private

Parameters

list<int>|string $obj_ids

Returns: list<int>

Definition at line 594 of file class.ilMailSearchObjectGUI.php.

                                                            : array
    {
        $own_obj_ids = $this->getOwnObjectIds();
        if ($obj_ids === 'ALL_OBJECTS') {
            return $own_obj_ids;
        }
 
        return array_values(array_intersect($obj_ids, $own_obj_ids));
    }

References getOwnObjectIds().

Referenced by mailObjects(), retrieveObjectIdsFromQuery(), and shareObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resolveUserIds()

ilMailSearchObjectGUI::resolveUserIds ( )

private

Returns: list<int>

Definition at line 618 of file class.ilMailSearchObjectGUI.php.

                                     : array
    {
        $member_row_ids = $this->retrieveMemberRowIdsFromQuery();
 
        $obj_ids = $this->retrieveObjectIdsFromQuery();
        $allowed_member_row_ids = $this->collectMemberRowIds($obj_ids);
        if ($member_row_ids === 'ALL_OBJECTS') {
            return array_values(array_unique(array_map(
                static fn(string $member_row_id): int => (int) explode('_', $member_row_id, 2)[1],
                $allowed_member_row_ids,
            )));
        }
 
        $allowed_row_ids = array_flip($allowed_member_row_ids);
        $usr_ids = [];
        foreach ($member_row_ids as $member_row_id) {
            $member_row_id = (string) $member_row_id;
            if (!isset($allowed_row_ids[$member_row_id])) {
                continue;
            }
 
            $usr_ids[] = (int) explode('_', $member_row_id, 2)[1];
        }
 
        return array_values(array_unique($usr_ids));
    }

References collectMemberRowIds(), ILIAS\Repository\int(), retrieveMemberRowIdsFromQuery(), and retrieveObjectIdsFromQuery().

Referenced by mailMembers(), and shareMembers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ retrieveIdsFromQuery()

ilMailSearchObjectGUI::retrieveIdsFromQuery ( string $key )

private

Returns: list<int>|string

Definition at line 703 of file class.ilMailSearchObjectGUI.php.

                                                      : array|string
    {
        return $this->http->wrapper()->query()->retrieve(
            $key,
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int()),
                $this->refinery->custom()->transformation(
                    static function (mixed $value): array|string {
                        if ($value === ['ALL_OBJECTS']) {
                            return 'ALL_OBJECTS';
                        }
                        if (!is_string($value) || $value === '') {
                            throw new Exception('invalid ids');
                        }
 
                        return array_map(intval(...), explode(',', $value));
                    }
                ),
                $this->refinery->always([])
            ])
        );
    }

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

Referenced by mailObjects(), retrieveObjectIdsFromQuery(), and shareObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ retrieveMemberRowIdsFromQuery()

ilMailSearchObjectGUI::retrieveMemberRowIdsFromQuery ( )

private

Returns: list<string>|string

Definition at line 671 of file class.ilMailSearchObjectGUI.php.

                                                    : array|string
    {
        return $this->http->wrapper()->query()->retrieve(
            'contact_mailinglist_search_members_ids',
            $this->refinery->byTrying([
                $this->refinery->custom()->transformation(
                    static function (mixed $value): string {
                        if ($value === 'ALL_OBJECTS' || (is_array($value) && ($value[0] ?? null) === 'ALL_OBJECTS')) {
                            return 'ALL_OBJECTS';
                        }
 
                        throw new Exception('not all objects');
                    }
                ),
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string()),
                $this->refinery->custom()->transformation(
                    static function (mixed $value): array {
                        if (!is_string($value) || $value === '') {
                            throw new Exception('invalid ids');
                        }
 
                        return explode(',', $value);
                    }
                ),
                $this->refinery->always([])
            ])
        );
    }

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

Referenced by resolveBuddyUserIdFromQuery(), and resolveUserIds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ retrieveObjectIdsFromQuery()

ilMailSearchObjectGUI::retrieveObjectIdsFromQuery ( )

private

Returns: list<int>

Definition at line 576 of file class.ilMailSearchObjectGUI.php.

                                                 : array
    {
        $obj_ids = $this->resolveObjectIds(
            $this->retrieveIdsFromQuery('contact_mailinglist_search_obj_ids')
        );
        if ($obj_ids !== []) {
            return $obj_ids;
        }
 
        return $this->resolveObjectIds(
            $this->retrieveIdsFromQuery('search_' . $this->getObjectType())
        );
    }

References getObjectType(), resolveObjectIds(), and retrieveIdsFromQuery().

Referenced by executeCommand(), and resolveUserIds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ shareMembers()

ilMailSearchObjectGUI::shareMembers ( )

private

Definition at line 429 of file class.ilMailSearchObjectGUI.php.

                                   : void
    {
        $usr_ids = $this->resolveUserIds();
 
        if ($usr_ids !== []) {
            $this->addPermission(array_unique($usr_ids));
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_select_one_entry'));
            $this->showMembers();
        }
    }

References addPermission(), ILIAS\Repository\lng(), and resolveUserIds().

Referenced by handleMailSearchObjectActions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ shareObjects()

ilMailSearchObjectGUI::shareObjects ( )

private

Definition at line 412 of file class.ilMailSearchObjectGUI.php.

                                   : void
    {
        $obj_ids = $this->resolveObjectIds(
            $this->retrieveIdsFromQuery('contact_mailinglist_search_obj_ids')
        );
 
        if ($obj_ids !== []) {
            $this->addPermission($obj_ids);
        } else {
            $this->tpl->setOnScreenMessage(
                'info',
                $this->lng->txt($this->getObjectType() === 'crs' ? 'mail_select_crs' : 'mail_select_grp'),
            );
            $this->showMyObjects();
        }
    }

References addPermission(), ILIAS\Repository\lng(), resolveObjectIds(), retrieveIdsFromQuery(), and showMyObjects().

Referenced by handleMailSearchObjectActions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showMyObjects()

ilMailSearchObjectGUI::showMyObjects ( )

private

Definition at line 351 of file class.ilMailSearchObjectGUI.php.

                                    : void
    {
        $this->tpl->setTitle($this->lng->txt('mail_addressbook'));
 
        if ($this->getContext() === self::CONTEXT_MAIL) {
            $this->tabs->clearTargets();
            $this->ctrl->setParameter($this, 'view', 'myobjects');
            $this->tabs->setBackTarget(
                $this->lng->txt('back'),
                $this->ctrl->getLinkTarget($this, self::CMD_CANCEL)
            );
        }
 
        $search_tpl = new ilTemplate(
            'tpl.mail_search_template.html',
            true,
            true,
            'components/ILIAS/Contact'
        );
 
        $this->lng->loadLanguageModule('crs');
 
        $table = new MailSearchObjectsTable(
            $this->user,
            $this,
            $this->ctrl,
            $this->lng,
            $this->ui_factory,
            $this->http,
            $this->tree,
        );
 
        if ($this->isDefaultRequestContext()) {
            $table->setMailingAllowed($this->mailing_allowed);
        }
 
        if ($table->getNumHiddenMembers() > 0) {
            $search_tpl->setCurrentBlock('caption_block');
            $search_tpl->setVariable(
                'TXT_LIST_MEMBERS_NOT_AVAILABLE',
                $this->lng->txt('mail_crs_list_members_not_available')
            );
            $search_tpl->parseCurrentBlock();
        }
 
        $search_tpl->setVariable('TABLE', $this->ui_renderer->render($table->getComponent()));
        $this->tpl->setContent($search_tpl->get());
 
        if ($this->isDefaultRequestContext()) {
            $this->tpl->printToStdout();
        }
    }