ilMailFormCall Class Reference

Statically used helper class for generating links to the mail form user interface. More...

Collaboration diagram for ilMailFormCall:

Static Public Member Functions
static	getLinkTarget ( $gui, string $cmd, array $gui_params=[], array $mail_params=[], array $context_params=[])
static	getRedirectTarget ( $gui, string $cmd, array $gui_params=[], array $mail_params=[], array $context_params=[])
static	storeReferer (array $queryParameters)
static	getSignature ()
static	getRefererRedirectUrl ()
static	isRefererStored ()
static	getContextId ()
static	setContextId (?string $id)
static	getContextParameters ()
static	setContextParameters (array $parameters)
static	setRecipients (array $recipients, string $type='to')
static	getRecipients (string $type='to')

Data Fields
const	SESSION_KEY = 'mail_transport'
const	REFERER_KEY = 'r'
const	SIGNATURE_KEY = 'sig'
const	CONTEXT_PREFIX = 'ctx'
const	CONTEXT_KEY = 'ctx_template'

Static Protected Member Functions
static	getTargetUrl (string $argument_separator, $gui, string $cmd, array $gui_params=[], array $mail_params=[], array $context_params=[])

Detailed Description

Statically used helper class for generating links to the mail form user interface.

Version

: $Id$

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 27 of file class.ilMailFormCall.php.

Member Function Documentation

getContextId()

static ilMailFormCall::getContextId ( )

static

Definition at line 216 of file class.ilMailFormCall.php.

References $session, and ilSession\get().

Referenced by ilMailFormGUI\editAttachments(), ilMailFormGUI\saveDraft(), ilMailFormGUI\saveMailBeforeSearch(), ilMailFormGUI\searchUsers(), ilForumMailEventNotificationSender\send(), ilMailFormGUI\sendMessage(), and ilMailFormGUI\showForm().

                                         : ?string
    {
        $session = ilSession::get(self::SESSION_KEY);
        return (
            isset($session[self::CONTEXT_PREFIX][self::CONTEXT_KEY]) &&
            is_string($session[self::CONTEXT_PREFIX][self::CONTEXT_KEY]) ?
            $session[self::CONTEXT_PREFIX][self::CONTEXT_KEY] : null
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getContextParameters()

static ilMailFormCall::getContextParameters ( )

static

Definition at line 233 of file class.ilMailFormCall.php.

References $session, and ilSession\get().

Referenced by ilMailFormGUI\editAttachments(), ilMailFormGUI\saveDraft(), ilMailFormGUI\saveMailBeforeSearch(), ilMailFormGUI\searchUsers(), ilForumMailEventNotificationSender\send(), and ilMailFormGUI\sendMessage().

                                                 : array
    {
        $session = ilSession::get(self::SESSION_KEY);
        if (isset($session[self::CONTEXT_PREFIX]) && is_array($session[self::CONTEXT_PREFIX])) {
            return $session[self::CONTEXT_PREFIX];
        }

        return [];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLinkTarget()

static ilMailFormCall::getLinkTarget (   $gui, string  $cmd, array  $gui_params = [], array  $mail_params = [], array  $context_params = []  )

static

Parameters

object | string	$gui
string	$cmd
array	$gui_params
array	$mail_params
array	$context_params

Returns

string

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

Referenced by ilMailUserActionProvider\collectActionsForTargetUser(), ilAppointmentPresentationCourseGUI\collectPropertiesAndActions(), ilAssignedUsersTableGUI\fillRow(), ilPublicUserProfileGUI\getEmbeddable(), and ilObjCourseGUI\infoScreen().

     : string {
        return self::getTargetUrl('&', $gui, $cmd, $gui_params, $mail_params, $context_params);
    }

Here is the caller graph for this function:

getRecipients()

static ilMailFormCall::getRecipients ( string  $type = 'to' )

static

Returns

list<string>

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

References ILIAS\LTI\ToolProvider\$key, $session, $type, and ilSession\get().

Referenced by ilMailGUI\executeCommand().

                                                             : array
    {
        $session = ilSession::get(self::SESSION_KEY) ?? [];
        $key = 'rcp_' . $type;
        if (isset($session[$key]) && is_array($session[$key])) {
            return array_map('strval', array_values($session[$key]));
        }

        return [];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRedirectTarget()

static ilMailFormCall::getRedirectTarget (   $gui, string  $cmd, array  $gui_params = [], array  $mail_params = [], array  $context_params = []  )

static

Parameters

object | string	$gui
string	$cmd
array	$gui_params
array	$mail_params
array	$context_params

Returns

string

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

Referenced by ilObjUserFolderGUI\mailObject(), ilSurveyParticipantsGUI\mailRatersObject(), ilObjRoleGUI\mailToRoleObject(), ilMailMemberSearchGUI\nextMailForm(), ilExerciseManagementGUI\redirectFeedbackMailObject(), ilAccessibilitySupportContactsGUI\sendIssueMail(), ilLPTableBaseGUI\sendMail(), ilObjContentObjectGUI\sendMailToBlockedUsers(), ilMembershipMailGUI\sendMailToSelectedUsers(), ilStudyProgrammeMailMemberSearchGUI\sendMailToSelectedUsers(), ilMailMemberSearchGUI\sendMailToSelectedUsers(), and ilMembershipGUI\sendMailToSelectedUsers().

     : string {
        return self::getTargetUrl('&', $gui, $cmd, $gui_params, $mail_params, $context_params);
    }

Here is the caller graph for this function:

getRefererRedirectUrl()

static ilMailFormCall::getRefererRedirectUrl ( )

static

Definition at line 177 of file class.ilMailFormCall.php.

References $parts, $session, $url, ilUtil\_getHttpPath(), ilSession\get(), and ilSession\set().

Referenced by ilMailFormGUI\cancelMail(), ilMailFormGUI\saveDraft(), and ilMailFormGUI\sendMessage().

                                                  : string
    {
        $url = '';
        $session = ilSession::get(self::SESSION_KEY);

        if (isset($session[self::REFERER_KEY])) {
            $url = $session[self::REFERER_KEY];
            if (is_string($url) && $url !== '') {
                $parts = parse_url($url);
                if (isset($parts['query']) && $parts['query'] !== '') {
                    $url .= '&returned_from_mail=1';
                } else {
                    $url .= '?returned_from_mail=1';
                }

                $ilias_url_parts = parse_url(ilUtil::_getHttpPath());
                if (isset($parts['host']) && $ilias_url_parts['host'] !== $parts['host']) {
                    $url = 'ilias.php?baseClass=ilMailGUI';
                }
            }

            unset($session[self::REFERER_KEY]);
            ilSession::set(self::SESSION_KEY, $session);
        }

        return $url;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSignature()

static ilMailFormCall::getSignature ( )

static

Definition at line 162 of file class.ilMailFormCall.php.

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

Referenced by ilMailFormGUI\showForm().

                                         : string
    {
        $sig = '';
        $session = ilSession::get(self::SESSION_KEY);

        if (isset($session[self::SIGNATURE_KEY])) {
            $sig = $session[self::SIGNATURE_KEY];

            unset($session[self::SIGNATURE_KEY]);
            ilSession::set(self::SESSION_KEY, $session);
        }

        return $sig;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTargetUrl()

static ilMailFormCall::getTargetUrl ( string  $argument_separator,   $gui, string  $cmd, array  $gui_params = [], array  $mail_params = [], array  $context_params = []  )

staticprotected

Parameters

string	$argument_separator
object | string	$gui
string	$cmd
array	$gui_params
array	$mail_params
array	$context_params

Returns

string

Definition at line 80 of file class.ilMailFormCall.php.

References $DIC, and ILIAS\LTI\ToolProvider\$key.

     : string {
        global $DIC;

        $mparams = '';
        $referer = '';

        foreach ($mail_params as $key => $value) {
            $mparams .= $argument_separator . $key . '=' . urlencode((string) $value);
        }

        foreach ($context_params as $key => $value) {
            if ($key === self::CONTEXT_KEY) {
                $mparams .= $argument_separator . $key . '=' . urlencode((string) $value);
            } else {
                $mparams .= $argument_separator . self::CONTEXT_PREFIX . '_' . $key . '=' . urlencode((string) $value);
            }
        }

        if (is_object($gui)) {
            $ilCtrlTmp = clone $DIC->ctrl();
            foreach ($gui_params as $key => $value) {
                $ilCtrlTmp->setParameter($gui, $key, $value);
            }
            $referer = $ilCtrlTmp->getLinkTarget($gui, $cmd, '');
        } elseif (is_string($gui)) {
            $referer = $gui;
        }

        $referer = $argument_separator . self::REFERER_KEY . '=' . rawurlencode(base64_encode($referer));

        return 'ilias.php?baseClass=ilMailGUI' . $referer . $mparams;
    }

isRefererStored()

static ilMailFormCall::isRefererStored ( )

static

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

References $session, and ilSession\get().

Referenced by ilMailFormGUI\cancelMail(), ilMailFormGUI\saveDraft(), ilMailFormGUI\sendMessage(), and ilMailFormGUI\showForm().

                                            : bool
    {
        $session = ilSession::get(self::SESSION_KEY);

        return (
            isset($session[self::REFERER_KEY]) &&
            is_string($session[self::REFERER_KEY]) &&
            $session[self::REFERER_KEY] !== ''
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setContextId()

static ilMailFormCall::setContextId ( ?string  $id )

static

Definition at line 226 of file class.ilMailFormCall.php.

References $id, $session, ilSession\get(), and ilSession\set().

Referenced by ilMailFormGUI\showForm().

                                                    : void
    {
        $session = ilSession::get(self::SESSION_KEY);
        $session[self::CONTEXT_KEY] = $id;
        ilSession::set(self::SESSION_KEY, $session);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setContextParameters()

static ilMailFormCall::setContextParameters ( array  $parameters )

static

Definition at line 243 of file class.ilMailFormCall.php.

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

Referenced by ilMailFormGUI\showForm().

                                                                  : void
    {
        $session = ilSession::get(self::SESSION_KEY);
        $session[self::CONTEXT_PREFIX] = $parameters;
        ilSession::set(self::SESSION_KEY, $session);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setRecipients()

static ilMailFormCall::setRecipients ( array  $recipients, string  $type = 'to'  )

static

Parameters

list<string>

$recipients

Definition at line 253 of file class.ilMailFormCall.php.

References $session, $type, ilSession\get(), and ilSession\set().

Referenced by ilMailGUI\executeCommand(), ilSurveyParticipantsGUI\mailRatersObject(), ilStudyProgrammeMailMemberSearchGUI\sendMailToSelectedUsers(), ilMailMemberSearchGUI\sendMailToSelectedUsers(), and ilMembershipGUI\sendMailToSelectedUsers().

                                                                                : void
    {
        $session = ilSession::get(self::SESSION_KEY) ?? [];
        $session['rcp_' . $type] = array_map('strval', array_values($recipients));
        ilSession::set(self::SESSION_KEY, $session);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

storeReferer()

static ilMailFormCall::storeReferer ( array  $queryParameters )

static

Parameters

array<string,mixed>

$queryParameters

Definition at line 123 of file class.ilMailFormCall.php.

References ILIAS\LTI\ToolProvider\$key, $session, ilSession\get(), and ilSession\set().

Referenced by ilMailGUI\executeCommand().

                                                               : void
    {
        $session = ilSession::get(self::SESSION_KEY);

        if (isset($queryParameters[self::REFERER_KEY])) {
            $session[self::REFERER_KEY] = base64_decode(rawurldecode($queryParameters[self::REFERER_KEY]));
            $session[self::SIGNATURE_KEY] = base64_decode(
                rawurldecode(
                    $queryParameters[self::SIGNATURE_KEY] ?? ''
                )
            );

            $contextParameters = [];
            foreach ($queryParameters as $key => $value) {
                $prefix = substr($key, 0, strlen(self::CONTEXT_PREFIX));
                if ($prefix === self::CONTEXT_PREFIX) {
                    if ($key === self::CONTEXT_KEY) {
                        $contextParameters[$key] = $value;
                    } else {
                        $contextParameters[substr($key, strlen(self::CONTEXT_PREFIX . '_'))] = $value;
                    }
                }
            }
            $session[self::CONTEXT_PREFIX] = $contextParameters;
        } else {
            if (isset($session[self::REFERER_KEY])) {
                unset($session[self::REFERER_KEY]);
            }
            if (isset($session[self::SIGNATURE_KEY])) {
                unset($session[self::SIGNATURE_KEY]);
            }
            if (isset($session[self::CONTEXT_PREFIX])) {
                unset($session[self::CONTEXT_PREFIX]);
            }
        }

        ilSession::set(self::SESSION_KEY, $session);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

CONTEXT_KEY

const ilMailFormCall::CONTEXT_KEY = 'ctx_template'

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

Referenced by ilAppointmentPresentationCourseGUI\collectPropertiesAndActions(), ilMailMemberSearchGUI\generateContextArray(), ilStudyProgrammeMailMemberSearchGUI\generateContextArray(), ilCourseMembershipGUI\getMailContextOptions(), ilSessionMembershipGUI\getMailContextOptions(), ilObjCourseGUI\infoScreen(), ilSurveyParticipantsGUI\mailRatersObject(), and ilLPTableBaseGUI\sendMail().

CONTEXT_PREFIX

const ilMailFormCall::CONTEXT_PREFIX = 'ctx'

Definition at line 32 of file class.ilMailFormCall.php.

REFERER_KEY

const ilMailFormCall::REFERER_KEY = 'r'

Definition at line 30 of file class.ilMailFormCall.php.

SESSION_KEY

const ilMailFormCall::SESSION_KEY = 'mail_transport'

Definition at line 29 of file class.ilMailFormCall.php.

SIGNATURE_KEY

const ilMailFormCall::SIGNATURE_KEY = 'sig'

Definition at line 31 of file class.ilMailFormCall.php.

Referenced by ilExerciseManagementGUI\redirectFeedbackMailObject().

---

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

• Services/Mail/classes/class.ilMailFormCall.php