Inheritance diagram for ilMailSearchObjectGUI:

Collaboration diagram for ilMailSearchObjectGUI:

Public Member Functions
	__construct ($wsp_access_handler=null, ?int $wsp_node_id=null)

	mailMembers ()

	cancel ()

	executeCommand ()

Protected Member Functions
	getObjectType ()

	getLocalDefaultRolePrefixes ()

	getRequestValue (string $key, \ILIAS\Refinery\Transformation $trafo, $default=null)

	addPermission (array $a_obj_ids)

	share ()

	mail ()

	mailObjects ()

	doesExposeMembers (ilObject $object)

Protected Attributes
GlobalHttpState	$http

Refinery	$refinery

string	$view = null

ilGlobalTemplateInterface	$tpl

ilCtrlInterface	$ctrl

ilLanguage	$lng

ilObjUser	$user

ilErrorHandling	$error

ilRbacSystem	$rbacsystem

ilRbacReview	$rbacreview

ilTree	$tree

ilObjectDataCache	$cache

ilFormatMail	$umail

bool	$mailing_allowed

	$wsp_access_handler = null

int	$wsp_node_id = null

Private Member Functions
	isDefaultRequestContext ()

	getContext ()

	isLocalRoleTitle (string $title)

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilMailSearchObjectGUI::__construct	(		$wsp_access_handler = `null`,
		?int	$wsp_node_id = `null`
	)

Parameters

ilWorkspaceAccessHandler \| ilPortfolioAccessHandler \| null	$wsp_access_handler
int \| null	$wsp_node_id

Exceptions

ilCtrlException

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

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

     {
         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->wsp_access_handler = $wsp_access_handler;
         $this->wsp_node_id = $wsp_node_id;
 
         $this->ctrl->saveParameter($this, 'mobj_id');
         $this->ctrl->saveParameter($this, 'ref');
 
         $mail = new ilMail($this->user->getId());
         $this->mailing_allowed = $this->rbacsystem->checkAccess('internal_mail', $mail->getMailObjectReferenceId());
 
         $this->umail = new ilFormatMail($this->user->getId());
     }

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

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

Referenced by share().

                                                       : void
     {
         $existing = $this->wsp_access_handler->getPermissions($this->wsp_node_id);
         $added = false;
         foreach ($a_obj_ids as $object_id) {
             if (!in_array($object_id, $existing, true)) {
                 $added = $this->wsp_access_handler->addPermission($this->wsp_node_id, $object_id);
             }
         }
 
         if ($added) {
             $this->tpl->setOnScreenMessage('success', $this->lng->txt('wsp_share_success'), true);
         }
         $this->ctrl->redirectByClass(ilWorkspaceAccessGUI::class, 'share');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cancel()

ilMailSearchObjectGUI::cancel ( )

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

References $context, $data, ILIAS\LTI\ToolProvider\$key, $path, $ref_id, ilObject\_getAllReferences(), ilParticipants\_getMembershipByType(), ilObject\_hasUntrashedReference(), ilObjUser\_lookupActive(), ilObjUser\_lookupPref(), ilUtil\_sortIds(), ilParticipants\canSendMailToMembers(), ilStr\convertUpperCamelCaseToUnderscoreCase(), ILIAS\Repository\ctrl(), doesExposeMembers(), ilSession\get(), ilObjUser\getActive(), getContext(), ilObjUser\getFirstname(), ilObject\getId(), ilBuddySystem\getInstance(), ilBuddyList\getInstanceByGlobalUser(), ilObjectFactory\getInstanceByObjId(), ilParticipants\getInstanceByObjId(), ilObjUser\getLastname(), ilObjUser\getLogin(), ilMailGlobalServices\getMailObjectRefId(), getObjectType(), ilObject\getRefId(), ilObject\getTitle(), ILIAS\FileDelivery\http(), isDefaultRequestContext(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilSession\set(), ilObject\setRefId(), and ILIAS\Repository\user().

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

Here is the call graph for this function:

◆ doesExposeMembers()

ilMailSearchObjectGUI::doesExposeMembers ( ilObject $object )

abstractprotected

Referenced by cancel().

Here is the caller graph for this function:

◆ executeCommand()

ilMailSearchObjectGUI::executeCommand ( )

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

References ILIAS\Repository\ctrl(), ilBuddySystem\getInstance(), getObjectType(), and ILIAS\Repository\lng().

                                     : 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);
                 }
 
                 $this->ctrl->saveParameter($this, 'search_' . $this->getObjectType());
 
                 $this->ctrl->setReturn($this, 'showMembers');
                 $this->ctrl->forwardCommand(new ilBuddySystemGUI());
                 break;
 
             default:
                 if (!($cmd = $this->ctrl->getCmd())) {
                     $cmd = 'showMyObjects';
                 }
 
                 $this->$cmd();
                 break;
         }
 
         return true;
     }

Here is the call graph for this function:

◆ getContext()

ilMailSearchObjectGUI::getContext ( )

private

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

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

Referenced by cancel().

                                  : string
     {
         $context = 'mail';
         if ($this->http->wrapper()->query()->has('ref')) {
             $context = $this->http->wrapper()->query()->retrieve('ref', $this->refinery->kindlyTo()->string());
         }
 
         return $context;
     }

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', ...]

Referenced by isLocalRoleTitle().

Here is the caller graph for this function:

◆ getObjectType()

ilMailSearchObjectGUI::getObjectType ( )

abstractprotected

Referenced by cancel(), executeCommand(), isLocalRoleTitle(), mail(), mailObjects(), and share().

Here is the caller graph for this function:

◆ getRequestValue()

ilMailSearchObjectGUI::getRequestValue	(	string	$key,
		\ILIAS\Refinery\Transformation	$trafo,
			$default = `null`
	)

protected

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

References ILIAS\FileDelivery\http().

     {
         $value = $default;
         if ($this->http->wrapper()->query()->has($key)) {
             $value = $this->http->wrapper()->query()->retrieve($key, $trafo);
         }
 
         if ($this->http->wrapper()->post()->has($key)) {
             $value = $this->http->wrapper()->post()->retrieve($key, $trafo);
         }
 
         return $value;
     }

Here is the call graph for this function:

◆ isDefaultRequestContext()

ilMailSearchObjectGUI::isDefaultRequestContext ( )

private

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

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

Referenced by cancel().

                                               : bool
     {
         return (
             !$this->http->wrapper()->query()->has('ref') ||
             $this->http->wrapper()->query()->retrieve('ref', $this->refinery->kindlyTo()->string()) !== 'wsp'
         );
     }

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

References getLocalDefaultRolePrefixes(), and getObjectType().

Referenced by mailObjects().

                                                     : bool
     {
         foreach ($this->getLocalDefaultRolePrefixes() as $local_role_prefix) {
             if (strpos($title, $local_role_prefix) === 0) {
                 return true;
             }
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mail()

ilMailSearchObjectGUI::mail ( )

protected

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

References getObjectType(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), mailMembers(), mailObjects(), and ILIAS\Repository\refinery().

                              : void
     {
         $view = '';
         if ($this->http->wrapper()->query()->has('view')) {
             $view = $this->http->wrapper()->query()->retrieve('view', $this->refinery->kindlyTo()->string());
         }
 
         if ($view === 'myobjects') {
             $obj_ids = [];
             if ($this->http->wrapper()->query()->has('search_' . $this->getObjectType())) {
                 $obj_ids = [
                     $this->http->wrapper()->query()->retrieve(
                         'search_' . $this->getObjectType(),
                         $this->refinery->kindlyTo()->int()
                     )
                 ];
             } elseif ($this->http->wrapper()->post()->has('search_' . $this->getObjectType())) {
                 $obj_ids = $this->http->wrapper()->post()->retrieve(
                     'search_' . $this->getObjectType(),
                     $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
                 );
             }
 
             if ($obj_ids !== []) {
                 $this->mailObjects();
             } else {
                 $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_select_course'));
                 $this->showMyObjects();
             }
         } elseif ($view === $this->getObjectType() . '_members') {
             $usr_ids = [];
             if ($this->http->wrapper()->query()->has('search_members')) {
                 $usr_ids = [
                     $this->http->wrapper()->query()->retrieve(
                         'search_members',
                         $this->refinery->kindlyTo()->int()
                     )
                 ];
             } elseif ($this->http->wrapper()->post()->has('search_members')) {
                 $usr_ids = $this->http->wrapper()->post()->retrieve(
                     'search_members',
                     $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
                 );
             }
 
             if ($usr_ids !== []) {
                 $this->mailMembers();
             } else {
                 $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_select_one_entry'));
                 $this->showMembers();
             }
         } else {
             $this->showMyObjects();
         }
     }

Here is the call graph for this function:

◆ mailMembers()

ilMailSearchObjectGUI::mailMembers ( )

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

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

Referenced by mail().

                                  : void
     {
         $members = [];
         $usr_ids = [];
         if ($this->http->wrapper()->query()->has('search_members')) {
             $usr_ids = [
                 $this->http->wrapper()->query()->retrieve(
                     'search_members',
                     $this->refinery->kindlyTo()->int()
                 )
             ];
         } elseif ($this->http->wrapper()->post()->has('search_members')) {
             $usr_ids = $this->http->wrapper()->post()->retrieve(
                 'search_members',
                 $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
             );
         }
 
         $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['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:

Here is the caller graph for this function:

◆ mailObjects()

ilMailSearchObjectGUI::mailObjects ( )

protected

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

References $ref_id, ilObject\_getAllReferences(), ilParticipants\canSendMailToMembers(), ILIAS\Repository\ctrl(), ilMailGlobalServices\getMailObjectRefId(), getObjectType(), ILIAS\FileDelivery\http(), isLocalRoleTitle(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

Referenced by mail().

                                     : void
     {
         $members = [];
         $mail_data = $this->umail->retrieveFromStage();
 
         $obj_ids = [];
         if ($this->http->wrapper()->query()->has('search_' . $this->getObjectType())) {
             $obj_ids = [
                 $this->http->wrapper()->query()->retrieve(
                     'search_' . $this->getObjectType(),
                     $this->refinery->kindlyTo()->int()
                 )
             ];
         } elseif ($this->http->wrapper()->post()->has('search_' . $this->getObjectType())) {
             $obj_ids = $this->http->wrapper()->post()->retrieve(
                 'search_' . $this->getObjectType(),
                 $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
             );
         }
 
         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['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:

Here is the caller graph for this function:

◆ share()

ilMailSearchObjectGUI::share ( )

protected

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

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

                               : void
     {
         $view = '';
         if ($this->http->wrapper()->query()->has('view')) {
             $view = $this->http->wrapper()->query()->retrieve('view', $this->refinery->kindlyTo()->string());
         }
 
         if ($view === 'myobjects') {
             $obj_ids = [];
             if ($this->http->wrapper()->query()->has('search_' . $this->getObjectType())) {
                 $obj_ids = [
                     $this->http->wrapper()->query()->retrieve(
                         'search_' . $this->getObjectType(),
                         $this->refinery->kindlyTo()->int()
                     )
                 ];
             } elseif ($this->http->wrapper()->post()->has('search_' . $this->getObjectType())) {
                 $obj_ids = $this->http->wrapper()->post()->retrieve(
                     'search_' . $this->getObjectType(),
                     $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
                 );
             }
 
             if ($obj_ids !== []) {
                 $this->addPermission($obj_ids);
             } else {
                 $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_select_course'));
                 $this->showMyObjects();
             }
         } elseif ($view === $this->getObjectType() . '_members') {
             $usr_ids = [];
             if ($this->http->wrapper()->query()->has('search_members')) {
                 $usr_ids = [
                     $this->http->wrapper()->query()->retrieve(
                         'search_members',
                         $this->refinery->kindlyTo()->int()
                     )
                 ];
             } elseif ($this->http->wrapper()->post()->has('search_members')) {
                 $usr_ids = $this->http->wrapper()->post()->retrieve(
                     'search_members',
                     $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
                 );
             }
 
             if ($usr_ids !== []) {
                 $this->addPermission($usr_ids);
             } else {
                 $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_select_one_entry'));
                 $this->showMembers();
             }
         } else {
             $this->showMyObjects();
         }
     }