ilMailMemberSearchGUI Class Reference

Class ilMailMemberSearchGUI. More...

Collaboration diagram for ilMailMemberSearchGUI:

Public Member Functions
	__construct ($gui, $ref_id, ilAbstractMailMemberRoles $objMailMemberRoles)
	ilMailMemberSearchGUI constructor. More...
	executeCommand ()
	storeReferer ()
	setObjParticipants (ilParticipants $objParticipants)

Protected Member Functions
	nextMailForm ()
	generateContextArray ()
	showSelectableUsers ()
	sendMailToSelectedUsers ()
	showSearchForm ()
	getObjParticipants ()
	initMailToMembersForm ()
	getMailRadioGroup ()

Protected Attributes
	$mail_roles
	$gui
	$objMailMemberRoles
	$objParticipants = null
	$ctrl
	$tpl
	$lng
	$access

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 56 of file class.ilMailMemberSearchGUI.php.

References $DIC, $gui, $objMailMemberRoles, and ilAbstractMailMemberRoles\getMailRoles().

    {
        global $DIC;

        $this->ctrl = $DIC['ilCtrl'];
        $this->tpl = $DIC['tpl'];
        $this->lng = $DIC['lng'];
        $this->access = $DIC['ilAccess'];

        $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 78 of file class.ilMailMemberSearchGUI.php.

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

                                     : bool
    {
        $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 189 of file class.ilMailMemberSearchGUI.php.

References $type, ilContainer\_lookupContainerSetting(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilMailFormCall\CONTEXT_KEY, ilObjectServiceSettingsGUI\EXTERNAL_MAIL_PREFIX, ilCourseMailTemplateTutorContext\ID, ilSessionMailTemplateParticipantContext\ID, and ilMail\PROP_CONTEXT_SUBJECT_PREFIX.

Referenced by nextMailForm(), and sendMailToSelectedUsers().

                                              : array
    {
        $contextParameters = [];

        $type = ilObject::_lookupType($this->ref_id, true);
        switch ($type) {
            case 'grp':
            case 'crs':
                if ($this->access->checkAccess('write', '', $this->ref_id)) {
                    $contextParameters = [
                        'ref_id' => $this->ref_id,
                        'ts' => time(),
                        ilMail::PROP_CONTEXT_SUBJECT_PREFIX => ilContainer::_lookupContainerSetting(
                            ilObject::_lookupObjId($this->ref_id),
                            ilObjectServiceSettingsGUI::EXTERNAL_MAIL_PREFIX,
                            ''
                        )
                    ];

                    if ('crs' === $type) {
                        $contextParameters[ilMailFormCall::CONTEXT_KEY] = ilCourseMailTemplateTutorContext::ID;
                    }
                }
                break;

            case 'sess':
                if ($this->access->checkAccess('write', '', $this->ref_id)) {
                    $contextParameters = [
                        ilMailFormCall::CONTEXT_KEY => ilSessionMailTemplateParticipantContext::ID,
                        'ref_id' => $this->ref_id,
                        'ts' => time()
                    ];
                }
                break;
        }

        return $contextParameters;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMailRadioGroup()

ilMailMemberSearchGUI::getMailRadioGroup ( )

protected

Returns

ilRadioGroupInputGUI

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

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

Referenced by initMailToMembersForm().

                                           : ilRadioGroupInputGUI
    {
        $mail_roles = $this->getMailRoles();

        $radio_grp = new ilRadioGroupInputGUI($this->lng->txt('mail_sel_label'), 'mail_member_type');

        $radio_sel_users = new ilRadioOption($this->lng->txt('mail_sel_users'), 'mail_sel_users');

        $radio_roles = new ilRadioOption($this->objMailMemberRoles->getRadioOptionTitle(), 'mail_member_roles');
        foreach ($mail_roles as $role) {
            $chk_role = new ilCheckboxInputGUI($role['form_option_title'], 'roles[]');

            if (array_key_exists('default_checked', $role) && $role['default_checked']) {
                $chk_role->setChecked(true);
            }
            $chk_role->setValue($role['role_id']);
            $chk_role->setInfo($role['mailbox']);
            $radio_roles->addSubItem($chk_role);
        }

        $radio_grp->setValue('mail_member_roles');

        $radio_grp->addOption($radio_sel_users);
        $radio_grp->addOption($radio_roles);

        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 324 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

ilParticipants

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

References $objParticipants.

Referenced by showSelectableUsers().

                                            : ilParticipants
    {
        return $this->objParticipants;
    }

Here is the caller graph for this function:

getStoredReferer()

ilMailMemberSearchGUI::getStoredReferer ( )

private

Returns

string

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

References ilSession\get().

Referenced by redirectToParentReferer().

                                        : string
    {
        return (string) ilSession::get('ilMailMemberSearchGUIReferer');
    }

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 303 of file class.ilMailMemberSearchGUI.php.

References getMailRadioGroup().

Referenced by nextMailForm(), and showSearchForm().

                                               : ilPropertyFormGUI
    {
        $this->lng->loadLanguageModule('mail');

        $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 144 of file class.ilMailMemberSearchGUI.php.

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

Referenced by executeCommand().

                                      : void
    {
        $form = $this->initMailToMembersForm();
        if ($form->checkInput()) {
            if ($form->getInput('mail_member_type') === 'mail_member_roles') {
                if (is_array($form->getInput('roles')) && count($form->getInput('roles')) > 0) {
                    $role_mail_boxes = [];
                    $roles = $form->getInput('roles');
                    foreach ($roles as $role_id) {
                        $mailbox = $this->objMailMemberRoles->getMailboxRoleAddress($role_id);
                        $role_mail_boxes[] = $mailbox;
                    }

                    $_SESSION['mail_roles'] = $role_mail_boxes;

                    $this->ctrl->redirectToURL(ilMailFormCall::getRedirectTarget(
                        $this,
                        'showSearchForm',
                        ['type' => 'role'],
                        [
                            'type' => 'role',
                            'rcp_to' => implode(',', $role_mail_boxes),
                            'sig' => $this->gui->createMailSignature()
                        ],
                        $this->generateContextArray()
                    ));
                } else {
                    $form->setValuesByPost();
                    ilUtil::sendFailure($this->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 118 of file class.ilMailMemberSearchGUI.php.

References $url, getStoredReferer(), and unsetStoredReferer().

Referenced by executeCommand().

                                               : void
    {
        $url = $this->getStoredReferer();
        $this->unsetStoredReferer();
        $this->ctrl->redirectToURL($url);
    }

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 241 of file class.ilMailMemberSearchGUI.php.

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

Referenced by executeCommand().

                                                 : bool
    {
        if (!isset($_POST['user_ids']) || !is_array($_POST['user_ids']) || 0 === count($_POST['user_ids'])) {
            ilUtil::sendFailure($this->lng->txt("no_checkbox"));
            $this->showSelectableUsers();
            return false;
        }

        $rcps = [];
        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);

        $this->ctrl->redirectToURL(ilMailFormCall::getRedirectTarget(
            $this,
            'members',
            [],
            [
                '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

(

ilParticipants

$objParticipants

)

Parameters

$objParticipants

ilParticipants

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

References $objParticipants.

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

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

Here is the caller graph for this function:

showSearchForm()

ilMailMemberSearchGUI::showSearchForm ( )

protected

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

References initMailToMembersForm(), and storeReferer().

Referenced by executeCommand(), and nextMailForm().

                                        : void
    {
        $this->storeReferer();

        $form = $this->initMailToMembersForm();
        $this->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 228 of file class.ilMailMemberSearchGUI.php.

References getObjParticipants().

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

                                             : void
    {
        $this->tpl->loadStandardTemplate();
        $tbl = new ilMailMemberSearchTableGUI($this, 'showSelectableUsers');
        $provider = new ilMailMemberSearchDataProvider($this->getObjParticipants(), $this->ref_id);
        $tbl->setData($provider->getData());

        $this->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 125 of file class.ilMailMemberSearchGUI.php.

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

Referenced by showSearchForm().

                                   : void
    {
        $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 139 of file class.ilMailMemberSearchGUI.php.

References ilSession\set().

Referenced by redirectToParentReferer().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilMailMemberSearchGUI::$access

protected

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

$ctrl

ilMailMemberSearchGUI::$ctrl

protected

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

$gui

ilMailMemberSearchGUI::$gui

protected

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

Referenced by __construct().

$lng

ilMailMemberSearchGUI::$lng

protected

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

$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().

$tpl

ilMailMemberSearchGUI::$tpl

protected

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

---

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

• Services/Contact/classes/class.ilMailMemberSearchGUI.php