Collaboration diagram for ilStudyProgrammeMailMemberSearchGUI:

Public Member Functions
	__construct (ilCtrl $ctrl, ilGlobalTemplateInterface $tpl, ilLanguage $lng, ilAccessHandler $access, ILIAS\HTTP\Wrapper\WrapperFactory $http_wrapper, ILIAS\Refinery\Factory $refinery, ilPRGPermissionsHelper $permission_helper)

	getAssignments ()

	setAssignments (array $assignments)

	getBackTarget ()

	setBackTarget (string $target)

	executeCommand ()

Protected Member Functions
	showSelectableUsers ()

	getProcessData ()

	getPRGMembersGUI ()

	retrieveUserIds ()

	sendMailToSelectedUsers ()

	generateContextArray ()

	redirectToParent ()

	createMailSignature ()

	getRootPrgRefId ()

	getRootPrgObjId ()

Protected Attributes
ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilAccessHandler	$access

ILIAS HTTP Wrapper WrapperFactory	$http_wrapper

ILIAS Refinery Factory	$refinery

array	$assignments = []

array	$user_ids = []

ilPRGPermissionsHelper	$permission_helper

Private Attributes
string	$back_target = null

Detailed Description

Definition at line 21 of file class.ilStudyProgrammeMailMemberSearchGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeMailMemberSearchGUI::__construct	(	ilCtrl	$ctrl,
		ilGlobalTemplateInterface	$tpl,
		ilLanguage	$lng,
		ilAccessHandler	$access,
		ILIAS\HTTP\Wrapper\WrapperFactory	$http_wrapper,
		ILIAS\Refinery\Factory	$refinery,
		ilPRGPermissionsHelper	$permission_helper
	)

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

References $access, $ctrl, $http_wrapper, $lng, $permission_helper, $refinery, $tpl, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

       {
         $this->ctrl = $ctrl;
         $this->tpl = $tpl;
         $this->lng = $lng;
         $this->access = $access;
         $this->http_wrapper = $http_wrapper;
         $this->refinery = $refinery;
         $this->permission_helper = $permission_helper;
 
         $this->lng->loadLanguageModule('mail');
         $this->lng->loadLanguageModule('search');
     }

Here is the call graph for this function:

Member Function Documentation

◆ createMailSignature()

ilStudyProgrammeMailMemberSearchGUI::createMailSignature ( )

protected

Definition at line 225 of file class.ilStudyProgrammeMailMemberSearchGUI.php.

References ilLink\_getLink(), getRootPrgRefId(), and ILIAS\Repository\lng().

Referenced by sendMailToSelectedUsers().

                                             : string
     {
         $link = chr(13) . chr(10) . chr(13) . chr(10);
         $link .= $this->lng->txt('prg_mail_permanent_link');
         $link .= chr(13) . chr(10) . chr(13) . chr(10);
         $link .= ilLink::_getLink($this->getRootPrgRefId());
         return rawurlencode(base64_encode($link));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilStudyProgrammeMailMemberSearchGUI::executeCommand ( )

Definition at line 76 of file class.ilStudyProgrammeMailMemberSearchGUI.php.

References ILIAS\Repository\ctrl(), getProcessData(), redirectToParent(), retrieveUserIds(), sendMailToSelectedUsers(), and showSelectableUsers().

                                     : void
     {
         $cmd = $this->ctrl->getCmd();
 
         $this->ctrl->setReturn($this, '');
 
         switch ($cmd) {
             case 'showSelectableUsers':
             case 'members':
                 $this->showSelectableUsers();
                 break;
             case 'sendMailToSelectedUsers':
                 $this->user_ids = $this->retrieveUserIds();
                 $this->sendMailToSelectedUsers();
                 break;
             case 'mailUserMulti':
                 $this->user_ids = array_keys($this->getProcessData());
                 $this->sendMailToSelectedUsers();
                 break;
             case 'cancel':
                 $this->redirectToParent();
                 break;
             default:
                 throw new Exception('Unknown command ' . $cmd);
         }
     }

Here is the call graph for this function:

◆ generateContextArray()

ilStudyProgrammeMailMemberSearchGUI::generateContextArray ( )

protected

Definition at line 196 of file class.ilStudyProgrammeMailMemberSearchGUI.php.

References $ref_id, $type, ilObject\_lookupType(), ILIAS\Repository\access(), ilMailFormCall\CONTEXT_KEY, getRootPrgRefId(), and ilStudyProgrammeMailTemplateContext\ID.

Referenced by sendMailToSelectedUsers().

                                              : array
     {
         $context_array = [];
         $ref_id = $this->getRootPrgRefId();
         $type = ilObject::_lookupType($ref_id, true);
         switch ($type) {
             case 'prg':
                 if ($this->access->checkAccess('write', "", $ref_id)) {
                     $context_array = array(
                         ilMailFormCall::CONTEXT_KEY => ilStudyProgrammeMailTemplateContext::ID,
                         'ref_id' => $ref_id,
                         'ts' => time()
                     );
                 }
                 break;
         }
         return $context_array;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignments()

ilStudyProgrammeMailMemberSearchGUI::getAssignments ( )

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

References $assignments.

Referenced by getProcessData(), getRootPrgObjId(), and getRootPrgRefId().

                                     : array
     {
         return $this->assignments;
     }

Here is the caller graph for this function:

◆ getBackTarget()

ilStudyProgrammeMailMemberSearchGUI::getBackTarget ( )

Definition at line 66 of file class.ilStudyProgrammeMailMemberSearchGUI.php.

References $back_target.

Referenced by redirectToParent().

                                    : ?string
     {
         return $this->back_target;
     }

Here is the caller graph for this function:

◆ getPRGMembersGUI()

ilStudyProgrammeMailMemberSearchGUI::getPRGMembersGUI ( )

protected

Definition at line 143 of file class.ilStudyProgrammeMailMemberSearchGUI.php.

References ilStudyProgrammeDIC\dic().

Referenced by sendMailToSelectedUsers().

                                          : ilObjStudyProgrammeMembersGUI
     {
         return ilStudyProgrammeDIC::dic()['ilObjStudyProgrammeMembersGUI'];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProcessData()

ilStudyProgrammeMailMemberSearchGUI::getProcessData ( )

protected

Definition at line 112 of file class.ilStudyProgrammeMailMemberSearchGUI.php.

References $data, $name, ilObjUser\_lookupLogin(), ilObjUser\_lookupName(), getAssignments(), and ilOrgUnitOperation\OP_MANAGE_MEMBERS.

Referenced by executeCommand(), and showSelectableUsers().

                                        : array
     {
         $data = [];
 
         foreach ($this->getAssignments() as $assignment) {
             $user_id = $assignment->getUserId();
             $name = ilObjUser::_lookupName($user_id);
             $login = ilObjUser::_lookupLogin($user_id);
 
             $publicName = $name['lastname'] . ', ' . $name['firstname'];
 
             $data[$user_id]['user_id'] = $user_id;
             $data[$user_id]['login'] = $login;
             $data[$user_id]['name'] = $publicName;
         }
 
         $allowed_user_ids = $this->permission_helper->filterUserIds(
             array_keys($data),
             ilOrgUnitOperation::OP_MANAGE_MEMBERS
         );
 
         $ret = [];
         foreach ($data as $usr_id => $entry) {
             if (in_array($usr_id, $allowed_user_ids)) {
                 $ret[$usr_id] = $entry;
             }
         }
         
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRootPrgObjId()

ilStudyProgrammeMailMemberSearchGUI::getRootPrgObjId ( )

protected

Definition at line 241 of file class.ilStudyProgrammeMailMemberSearchGUI.php.

References getAssignments().

Referenced by showSelectableUsers().

                                         : int
     {
         $assignments = $this->getAssignments();
         $assignment = array_shift($assignments);
         return (int) $assignment->getRootId();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRootPrgRefId()

ilStudyProgrammeMailMemberSearchGUI::getRootPrgRefId ( )

protected

Definition at line 234 of file class.ilStudyProgrammeMailMemberSearchGUI.php.

References getAssignments(), and ilObjStudyProgramme\getRefIdFor().

Referenced by createMailSignature(), and generateContextArray().

                                         : int
     {
         $assignments = $this->getAssignments();
         $assignment = array_shift($assignments);
         return ilObjStudyProgramme::getRefIdFor($assignment->getRootId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ redirectToParent()

ilStudyProgrammeMailMemberSearchGUI::redirectToParent ( )

protected

Definition at line 215 of file class.ilStudyProgrammeMailMemberSearchGUI.php.

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

Referenced by executeCommand().

                                          : void
     {
         $back_target = $this->getBackTarget();
         if (is_null($back_target)) {
             throw new LogicException("Can't redirect. No back target given.");
         }
 
         $this->ctrl->redirectToURL($back_target);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ retrieveUserIds()

ilStudyProgrammeMailMemberSearchGUI::retrieveUserIds ( )

protected

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

References $user_ids, and ILIAS\Repository\refinery().

Referenced by executeCommand().

                                         : array
     {
         $user_ids = [];
         if ($this->http_wrapper->post()->has("user_ids")) {
             $user_ids = $this->http_wrapper->post()->retrieve(
                 "user_ids",
                 $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
             );
         }
         return $user_ids;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendMailToSelectedUsers()

ilStudyProgrammeMailMemberSearchGUI::sendMailToSelectedUsers ( )

protected

Definition at line 160 of file class.ilStudyProgrammeMailMemberSearchGUI.php.

References $user_ids, ilObjUser\_lookupLogin(), createMailSignature(), ILIAS\Repository\ctrl(), generateContextArray(), getPRGMembersGUI(), ilMailFormCall\getRedirectTarget(), ILIAS\Repository\lng(), ilMailFormCall\setRecipients(), and showSelectableUsers().

Referenced by executeCommand().

                                                 : bool
     {
         $user_ids = $this->user_ids;
         if (!count($user_ids)) {
             $this->tpl->setOnScreenMessage("failure", $this->lng->txt("no_checkbox"));
             $this->showSelectableUsers();
             return false;
         }
 
         $rcps = array();
         foreach ($user_ids as $usr_id) {
             $rcps[] = ilObjUser::_lookupLogin($usr_id);
         }
 
         if (!count(array_filter($rcps))) {
             $this->tpl->setOnScreenMessage("failure", $this->lng->txt("no_checkbox"));
             $this->showSelectableUsers();
             return false;
         }
         ilMailFormCall::setRecipients($rcps);
 
         $members_gui = $this->getPRGMembersGUI();
         $this->ctrl->redirectToURL(ilMailFormCall::getRedirectTarget(
             $members_gui,
             'view',
             array(),
             array(
                 'type' => 'new',
                 'sig' => $this->createMailSignature()
             ),
             $this->generateContextArray()
         ));
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAssignments()

ilStudyProgrammeMailMemberSearchGUI::setAssignments ( array $assignments )

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

References $assignments.

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

◆ setBackTarget()

ilStudyProgrammeMailMemberSearchGUI::setBackTarget ( string $target )

Definition at line 71 of file class.ilStudyProgrammeMailMemberSearchGUI.php.

                                                  : void
     {
         $this->back_target = $target;
     }

◆ showSelectableUsers()

ilStudyProgrammeMailMemberSearchGUI::showSelectableUsers ( )

protected

Definition at line 103 of file class.ilStudyProgrammeMailMemberSearchGUI.php.

References getProcessData(), and getRootPrgObjId().

Referenced by executeCommand(), and sendMailToSelectedUsers().

                                             : void
     {
         $this->tpl->loadStandardTemplate();
         $tbl = new ilStudyProgrammeMailMemberSearchTableGUI($this, $this->getRootPrgObjId(), 'showSelectableUsers');
         $tbl->setData($this->getProcessData());
 
         $this->tpl->setContent($tbl->getHTML());
     }