Collaboration diagram for ilMailMemberSearchGUI:

Public Member Functions
	__construct ($gui, $ref_id, ilAbstractMailMemberRoles $objMailMemberRoles)
	ilMailMemberSearchGUI constructor. More...

	executeCommand ()

	storeReferer ()

	setObjParticipants ($objParticipants)

Protected Member Functions
	nextMailForm ()

	generateContextArray ()

	showSelectableUsers ()

	sendMailToSelectedUsers ()

	showSearchForm ()

	getObjParticipants ()

	initMailToMembersForm ()

	getMailRadioGroup ()

Protected Attributes
	$mail_roles

	$gui

	$objMailMemberRoles

	$objParticipants = NULL

Private Member Functions
	redirectToParentReferer ()

	getStoredReferer ()

	unsetStoredReferer ()

	getMailRoles ()

Detailed Description

Class ilMailMemberSearchGUI.

Author: Nadia Matuschek nmatu.nosp@m.sche.nosp@m.k@dat.nosp@m.abay.nosp@m..de

Definition at line 9 of file class.ilMailMemberSearchGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilMailMemberSearchGUI::__construct	(		$gui,
			$ref_id,
		ilAbstractMailMemberRoles	$objMailMemberRoles
	)

ilMailMemberSearchGUI constructor.

Parameters

ilObjGroupGUI \| ilObjCourseGUI	$gui
	$ref_id
ilAbstractMailMemberRoles	$objMailMemberRoles

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

References $gui, $ilCtrl, $lng, $objMailMemberRoles, $ref_id, $tpl, and ilAbstractMailMemberRoles\getMailRoles().

         {
                 global $ilCtrl, $tpl, $lng;
                 
                 $this->ctrl = $ilCtrl;
                 $this->tpl = $tpl;
                 $this->lng = $lng;
                 
                 $this->lng->loadLanguageModule('mail');
                 $this->lng->loadLanguageModule('search');
 
                 $this->gui    = $gui;
                 $this->ref_id = $ref_id;
 
                 $this->objMailMemberRoles = $objMailMemberRoles;
                 $this->mail_roles = $objMailMemberRoles->getMailRoles($ref_id);
         }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilMailMemberSearchGUI::executeCommand ( )

Returns: bool

Definition at line 57 of file class.ilMailMemberSearchGUI.php.

References $_GET, $cmd, nextMailForm(), redirectToParentReferer(), sendMailToSelectedUsers(), showSearchForm(), and showSelectableUsers().

         {
                 $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':
                                                 $this->showSelectableUsers();
                                                 break;
                                         
                                         case 'nextMailForm':
                                                 $this->nextMailForm();
                                                 break;
                         
                                         case 'cancel':
                                                 $this->redirectToParentReferer();
                                                 break;
                                         
                                         default:
                                                 if(isset($_GET['returned_from_mail']) && $_GET['returned_from_mail'] == '1')
                                                 {
                                                         $this->redirectToParentReferer();
                                                 }       
                                                 $this->showSearchForm();
                                                 break;
                                 }       
                                 break;
                 }
                 return true;
         }

Here is the call graph for this function:

◆ generateContextArray()

ilMailMemberSearchGUI::generateContextArray ( )

protected

Returns: array

Definition at line 187 of file class.ilMailMemberSearchGUI.php.

References ilMailFormCall\CONTEXT_KEY, and ilCourseMailTemplateTutorContext\ID.

Referenced by nextMailForm(), and sendMailToSelectedUsers().

         {
                 global $ilAccess;
                 
                 $context_array = array();
                 require_once 'Modules/Course/classes/class.ilCourseMailTemplateTutorContext.php';
                 if($ilAccess->checkAccess('write',"",$this->ref_id) )
                 {
                         $context_array = array(ilMailFormCall::CONTEXT_KEY => ilCourseMailTemplateTutorContext::ID,
                                                'ref_id' => $this->ref_id,
                                                'ts'     => time());
                 }
                 return $context_array;
         }       

Here is the caller graph for this function:

◆ getMailRadioGroup()

ilMailMemberSearchGUI::getMailRadioGroup ( )

protected

Returns: ilRadioGroupInputGUI

Definition at line 323 of file class.ilMailMemberSearchGUI.php.

References $mail_roles, getMailRoles(), and ilRadioOption\setValue().

Referenced by initMailToMembersForm().

         {
                 $mail_roles = $this->getMailRoles();
                 
                 $radio_grp   = new ilRadioGroupInputGUI('', 'mail_member_type');
                 $radio_roles = new ilRadioOption($this->objMailMemberRoles->getRadioOptionTitle(), 'mail_member_roles');
                 foreach($mail_roles as $role)
                 {
                         $chk_role     = new ilCheckboxInputGUI($role['form_option_title'], 'roles[]');
                         $chk_role->setValue($role['role_id']);
                         $chk_role->setInfo($role['mailbox']);
                         $radio_roles->addSubItem($chk_role);
                 }
 
                 $radio_sel_users = new ilRadioOption($this->lng->txt('mail_sel_users'), 'mail_sel_users');
 
                 $radio_grp->setValue('mail_member_roles');
                 $radio_grp->addOption($radio_roles);
                 $radio_grp->addOption($radio_sel_users);
                 
                 return $radio_grp;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMailRoles()

ilMailMemberSearchGUI::getMailRoles ( )

private

Returns: mixed

Definition at line 315 of file class.ilMailMemberSearchGUI.php.

References $mail_roles.

Referenced by getMailRadioGroup().

         {
                 return $this->mail_roles;
         }

Here is the caller graph for this function:

◆ getObjParticipants()

ilMailMemberSearchGUI::getObjParticipants ( )

protected

Returns: null

Definition at line 277 of file class.ilMailMemberSearchGUI.php.

References $objParticipants.

Referenced by showSelectableUsers().

         {
                 return $this->objParticipants;
         }

Here is the caller graph for this function:

◆ getStoredReferer()

ilMailMemberSearchGUI::getStoredReferer ( )

private

Returns: bool || redirect target

Definition at line 117 of file class.ilMailMemberSearchGUI.php.

References ilSession\get().

Referenced by redirectToParentReferer().

         {
                 $stored_referer = ilSession::get('ilMailMemberSearchGUIReferer');
                 return (strlen($stored_referer) ? $stored_referer : false);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initMailToMembersForm()

ilMailMemberSearchGUI::initMailToMembersForm ( )

protected

Returns: ilPropertyFormGUI

Definition at line 293 of file class.ilMailMemberSearchGUI.php.

References getMailRadioGroup().

Referenced by nextMailForm(), and showSearchForm().

         {
                 $this->lng->loadLanguageModule('mail');
 
                 include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
                 $form = new ilPropertyFormGUI();
                 $form->setTitle($this->lng->txt('mail_members'));
 
                 $form->setFormAction($this->ctrl->getFormAction($this, 'nextMailForm'));
 
                 $radio_grp = $this->getMailRadioGroup();
 
                 $form->addItem($radio_grp);
                 $form->addCommandButton('nextMailForm', $this->lng->txt('mail_members_search_continue'));
                 $form->addCommandButton('cancel', $this->lng->txt('cancel'));
 
                 return $form;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nextMailForm()

ilMailMemberSearchGUI::nextMailForm ( )

protected

Definition at line 134 of file class.ilMailMemberSearchGUI.php.

References $_SESSION, $lng, generateContextArray(), ilMailFormCall\getRedirectTarget(), initMailToMembersForm(), ilUtil\redirect(), ilUtil\sendFailure(), showSearchForm(), and showSelectableUsers().

Referenced by executeCommand().

         {
                 global $lng;
                 
                 $form = $this->initMailToMembersForm();
                 if($form->checkInput())
                 {
                         if($form->getInput('mail_member_type') == 'mail_member_roles')
                         {
                                 if(count($form->getInput('roles')) > 0)
                                 {
                                         $role_mail_boxes = array();
                                         $roles = $form->getInput('roles');
                                         foreach($roles as $role_id)
                                         {
                                                 $mailbox = $this->objMailMemberRoles->getMailboxRoleAddress($role_id);
                                                 $role_mail_boxes[] = $mailbox;
                                         }
 
                                         require_once 'Services/Mail/classes/class.ilMailFormCall.php';
                                         $_SESSION['mail_roles'] = $role_mail_boxes;
                                                         
                                         ilUtil::redirect(ilMailFormCall::getRedirectTarget(
                                                 $this, 'showSearchForm',
                                                 array('type' => 'role'),
                                                 array('type' => 'role',
                                                       'rcp_to' => implode(',', $role_mail_boxes),
                                                       'sig' =>  $this->gui->createMailSignature()),
                                                 $this->generateContextArray()
                                         ));
                                 }
                                 else
                                 {
                                         $form->setValuesByPost();
                                         ilUtil::sendFailure($lng->txt('no_checkbox'));
                                         $this->showSearchForm();
                                         return;
                                 }
                         }
                         else
                         {
                                 $this->showSelectableUsers();
                                 return;
                         }
                 }
 
                 $form->setValuesByPost();
                 $this->showSearchForm();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ redirectToParentReferer()

ilMailMemberSearchGUI::redirectToParentReferer ( )

private

Definition at line 98 of file class.ilMailMemberSearchGUI.php.

References getStoredReferer(), ilUtil\redirect(), and unsetStoredReferer().

Referenced by executeCommand().

         {
                 $redirect_target = $this->getStoredReferer();
                 $this->unsetStoredReferer();
                 ilUtil::redirect($redirect_target);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendMailToSelectedUsers()

ilMailMemberSearchGUI::sendMailToSelectedUsers ( )

protected

Returns: bool

Definition at line 223 of file class.ilMailMemberSearchGUI.php.

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

Referenced by executeCommand().

         {
                 if(!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;
                 }
 
                 require_once 'Services/Mail/classes/class.ilMailFormCall.php';
                 ilMailFormCall::setRecipients($rcps);
                 
                 ilUtil::redirect(ilMailFormCall::getRedirectTarget(
                         $this, 'members', 
                         array(),
                         array(
                                 'type' => 'new',
                                 'sig'  =>  $this->gui->createMailSignature()
                         ),
                         $this->generateContextArray()
                 ));
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setObjParticipants()

ilMailMemberSearchGUI::setObjParticipants ( $objParticipants )

Parameters

null $objParticipants ilCourseParticipants || ilGroupParticipants

Definition at line 285 of file class.ilMailMemberSearchGUI.php.

References $objParticipants.

Referenced by ilObjGroupGUI\executeCommand(), and ilObjCourseGUI\executeCommand().

         {
                 $this->objParticipants = $objParticipants;
         }

Here is the caller graph for this function:

◆ showSearchForm()

ilMailMemberSearchGUI::showSearchForm ( )

protected

Definition at line 263 of file class.ilMailMemberSearchGUI.php.

References $tpl, initMailToMembersForm(), and storeReferer().

Referenced by executeCommand(), and nextMailForm().

         {
                 global $tpl;
                 
                 $this->storeReferer();
                 $tpl->getStandardTemplate();
                 
                 $form = $this->initMailToMembersForm();
                 $tpl->setContent($form->getHTML());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showSelectableUsers()

ilMailMemberSearchGUI::showSelectableUsers ( )

protected

Definition at line 205 of file class.ilMailMemberSearchGUI.php.

References League\OAuth2\Client\Provider\$provider, $tbl, $tpl, and getObjParticipants().

Referenced by executeCommand(), nextMailForm(), and sendMailToSelectedUsers().

         {
                 global $tpl;
                 
                 include_once './Services/Contact/classes/class.ilMailMemberSearchTableGUI.php';
                 include_once './Services/Contact/classes/class.ilMailMemberSearchDataProvider.php';
                 
                 $tpl->getStandardTemplate();
                 $tbl = new ilMailMemberSearchTableGUI($this, 'showSelectableUsers');
                 $provider = new ilMailMemberSearchDataProvider($this->getObjParticipants());
                 $tbl->setData($provider->getData());
                 
                 $tpl->setContent($tbl->getHTML());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storeReferer()

ilMailMemberSearchGUI::storeReferer ( )

Definition at line 108 of file class.ilMailMemberSearchGUI.php.

References ilSession\get(), and ilSession\set().

Referenced by showSearchForm().

         {
                 $referer = ilSession::get('referer');
                 ilSession::set('ilMailMemberSearchGUIReferer', $referer);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unsetStoredReferer()

ilMailMemberSearchGUI::unsetStoredReferer ( )

private

Definition at line 126 of file class.ilMailMemberSearchGUI.php.

References ilSession\set().

Referenced by redirectToParentReferer().

         {
                 ilSession::set('ilMailMemberSearchGUIReferer','');
         }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $gui

ilMailMemberSearchGUI::$gui

protected

Definition at line 19 of file class.ilMailMemberSearchGUI.php.

Referenced by __construct().

◆ $mail_roles

ilMailMemberSearchGUI::$mail_roles

protected

Definition at line 14 of file class.ilMailMemberSearchGUI.php.

Referenced by getMailRadioGroup(), and getMailRoles().

◆ $objMailMemberRoles

ilMailMemberSearchGUI::$objMailMemberRoles

protected

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

Referenced by __construct().

◆ $objParticipants

ilMailMemberSearchGUI::$objParticipants = NULL

protected

Definition at line 28 of file class.ilMailMemberSearchGUI.php.

Referenced by getObjParticipants(), and setObjParticipants().

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

Services/Contact/classes/class.ilMailMemberSearchGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ executeCommand()

◆ generateContextArray()

◆ getMailRadioGroup()

◆ getMailRoles()

◆ getObjParticipants()

◆ getStoredReferer()

◆ initMailToMembersForm()

◆ nextMailForm()

◆ redirectToParentReferer()

◆ sendMailToSelectedUsers()

◆ setObjParticipants()

◆ showSearchForm()

◆ showSelectableUsers()

◆ storeReferer()

◆ unsetStoredReferer()

Field Documentation

◆ $gui

◆ $mail_roles

◆ $objMailMemberRoles

◆ $objParticipants