Collaboration diagram for ilStudyProgrammeMailMemberSearchGUI:

Public Member Functions
	__construct (ilCtrl $ctrl, ilGlobalTemplateInterface $tpl, ilLanguage $lng, ilAccessHandler $access)

	getAssignments ()

	setAssignments (array $assignments)

	getBackTarget ()

	setBackTarget (string $target)

	executeCommand ()

Protected Member Functions
	showSelectableUsers ()

	getProcessData ()

	sendMailToSelectedUsers ()

	generateContextArray ()

	redirectToParent ()

	createMailSignature ()

	getObjectRefId ()

Protected Attributes
	$gui

	$ctrl

	$tpl

	$lng

	$access

	$assignments

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeMailMemberSearchGUI::__construct	(	ilCtrl	$ctrl,
		ilGlobalTemplateInterface	$tpl,
		ilLanguage	$lng,
		ilAccessHandler	$access
	)

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

References $access, $ctrl, $lng, and $tpl.

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

Member Function Documentation

◆ createMailSignature()

ilStudyProgrammeMailMemberSearchGUI::createMailSignature ( )

protected

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

References ilLink\_getLink(), and getObjectRefId().

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);
         include_once 'Services/Link/classes/class.ilLink.php';
         $link .= ilLink::_getLink($this->getObjectRefId());
         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 74 of file class.ilStudyProgrammeMailMemberSearchGUI.php.

References redirectToParent(), sendMailToSelectedUsers(), and showSelectableUsers().

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

Here is the call graph for this function:

◆ generateContextArray()

ilStudyProgrammeMailMemberSearchGUI::generateContextArray ( )

protected

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

References $type, ilObject\_lookupType(), ilMailFormCall\CONTEXT_KEY, getObjectRefId(), and ilStudyProgrammeMailTemplateContext\ID.

Referenced by sendMailToSelectedUsers().

                                               : array
     {
         $context_array = [];
         $ref_id = $this->getObjectRefId();
         $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 54 of file class.ilStudyProgrammeMailMemberSearchGUI.php.

References $assignments.

Referenced by getObjectRefId(), and getProcessData().

                                      : array
     {
         return $this->assignments;
     }

Here is the caller graph for this function:

◆ getBackTarget()

ilStudyProgrammeMailMemberSearchGUI::getBackTarget ( )

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

Referenced by redirectToParent().

                                     : string
     {
         return $this->back_target;
     }

Here is the caller graph for this function:

◆ getObjectRefId()

ilStudyProgrammeMailMemberSearchGUI::getObjectRefId ( )

protected

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

References getAssignments().

Referenced by createMailSignature(), and generateContextArray().

                                         : int
     {
         $assignment = array_shift($this->getAssignments());
         $obj = $assignment->getStudyProgramme();
         return $obj->getRefId();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProcessData()

ilStudyProgrammeMailMemberSearchGUI::getProcessData ( )

protected

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

References $data, $login, $name, ilObjUser\_lookupLogin(), ilObjUser\_lookupName(), ilObjUser\_lookupPref(), and getAssignments().

Referenced by showSelectableUsers().

                                         : array
     {
         $data = [];
 
         foreach ($this->getAssignments() as $assignment) {
             $user_id = $assignment->getUserId();
             $name = ilObjUser::_lookupName($user_id);
             $login = ilObjUser::_lookupLogin($user_id);
 
             $publicName = '';
             if (in_array(ilObjUser::_lookupPref($user_id, 'public_profile'), array('g', 'y'))) {
                 $publicName = $name['lastname'] . ', ' . $name['firstname'];
             }
 
             $data[$user_id]['user_id'] = $user_id;
             $data[$user_id]['login'] = $login;
             $data[$user_id]['name'] = $publicName;
         }
 
         return $data;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ redirectToParent()

ilStudyProgrammeMailMemberSearchGUI::redirectToParent ( )

protected

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

References getBackTarget(), and ilUtil\redirect().

Referenced by executeCommand().

                                           : void
     {
         ilUtil::redirect($this->getBackTarget());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendMailToSelectedUsers()

ilStudyProgrammeMailMemberSearchGUI::sendMailToSelectedUsers ( )

protected

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

References $_POST, ilObjUser\_lookupLogin(), createMailSignature(), generateContextArray(), ilMailFormCall\getRedirectTarget(), ilUtil\redirect(), ilUtil\sendFailure(), ilMailFormCall\setRecipients(), and showSelectableUsers().

Referenced by executeCommand().

                                                  : bool
     {
         if (!isset($_POST['user_ids']) || !count($_POST['user_ids'])) {
             ilUtil::sendFailure($this->lng->txt("no_checkbox"));
             $this->showSelectableUsers();
             return false;
         }
 
         $rcps = array();
         foreach ($_POST['user_ids'] as $usr_id) {
             $rcps[] = ilObjUser::_lookupLogin($usr_id);
         }
 
         if (!count(array_filter($rcps))) {
             ilUtil::sendFailure($this->lng->txt("no_checkbox"));
             $this->showSelectableUsers();
             return false;
         }
         ilMailFormCall::setRecipients($rcps);
 
         ilUtil::redirect(ilMailFormCall::getRedirectTarget(
             $this,
             'members',
             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 59 of file class.ilStudyProgrammeMailMemberSearchGUI.php.

References $assignments.

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

◆ setBackTarget()

ilStudyProgrammeMailMemberSearchGUI::setBackTarget ( string $target )

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

     {
         $this->back_target = $target;
     }

◆ showSelectableUsers()

ilStudyProgrammeMailMemberSearchGUI::showSelectableUsers ( )

protected

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

References getProcessData().

Referenced by executeCommand(), and sendMailToSelectedUsers().

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