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, $cmd, array $gui_params=array(), array $mail_params=array(), $context_params=array())
static	getRedirectTarget ($gui, $cmd, array $gui_params=array(), array $mail_params=array(), array $context_params=array())
static	storeReferer ($request_params)
static	getSignature ()
	Get preset signature. More...
static	getRefererRedirectUrl ()
static	isRefererStored ()
static	getContextId ()
static	setContextId ($id)
static	getContextParameters ()
static	setContextParameters (array $parameters)
static	setRecipients (array $recipients)
static	getRecipients ()

Data Fields
const	SESSION_KEY = 'mail_transport'
const	REFERER_KEY = 'r'
	HTTP-GET parameter for the referer url. More...
const	SIGNATURE_KEY = 'sig'
	Session parameter for the hash. More...
const	CONTEXT_PREFIX = 'ctx'
	Session parameter for the context. More...
const	CONTEXT_KEY = 'ctx_template'
	Session parameter for the context. More...

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

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 10 of file class.ilMailFormCall.php.

Member Function Documentation

getContextId()

static ilMailFormCall::getContextId ( )

static

Returns

string|null

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

References $session, and ilSession\get().

Referenced by ilMailFormGUI\editAttachments(), ilMail\replacePlaceholders(), ilMailFormGUI\saveDraft(), ilMailFormGUI\saveMailBeforeSearch(), ilMailFormGUI\searchUsers(), and ilMailFormGUI\showForm().

    {
        $session = ilSession::get(self::SESSION_KEY);
        return (
            isset($session[self::CONTEXT_PREFIX][self::CONTEXT_KEY]) &&
            strlen($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

Returns

array context parameters

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

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

Referenced by ilMailFormGUI\editAttachments(), ilMail\replacePlaceholders(), ilMailFormGUI\saveDraft(), ilMailFormGUI\saveMailBeforeSearch(), ilMailFormGUI\searchUsers(), and ilObjSurvey\sentReminderPlaceholders().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getLinkTarget()

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

static

Parameters

mixed	$gui
string	$cmd
array	$gui_params
array	$mail_params
array	$context_params

Returns

string

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

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

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

Here is the caller graph for this function:

getRecipients()

static ilMailFormCall::getRecipients ( )

static

Returns

array

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

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

Referenced by ilMailGUI\executeCommand().

    {
        $session = ilSession::get(self::SESSION_KEY);
        return (array) $session['rcp_to'];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRedirectTarget()

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

static

Parameters

mixed	$gui
string	$cmd
array	$gui_params
array	$mail_params
array	$context_params

Returns

string

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

Referenced by ilObjUserFolderGUI\mailObject(), ilObjRoleGUI\mailToRoleObject(), ilMailMemberSearchGUI\nextMailForm(), ilExerciseManagementGUI\redirectFeedbackMailObject(), ilLPTableBaseGUI\sendMail(), ilBookmarkAdministrationGUI\sendmail(), ilObjContentObjectGUI\sendMailToBlockedUsers(), ilMembershipMailGUI\sendMailToSelectedUsers(), ilMailMemberSearchGUI\sendMailToSelectedUsers(), and ilMembershipGUI\sendMailToSelectedUsers().

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

Here is the caller graph for this function:

getRefererRedirectUrl()

static ilMailFormCall::getRefererRedirectUrl ( )

static

Returns

string

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

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

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

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

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

        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

Get preset signature.

Returns

string signature

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

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

Referenced by ilMailFormGUI\showForm().

    {
        $session = ilSession::get(self::SESSION_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 (   $argument_separator,   $gui,   $cmd, array  $gui_params = array(), array  $mail_params = array(), array  $context_params = array()  )

staticprotected

Parameters

string	$argument_separator
mixed	$gui
string	$cmd
array	$gui_params
array	$mail_params

Returns

string

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

References $DIC, and $key.

    {
        global $DIC;

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

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

        foreach ($context_params as $key => $value) {
            if ($key == self::CONTEXT_KEY) {
                $mparams .= $argument_separator . $key . '=' . urlencode($value);
            } else {
                $mparams .= $argument_separator . self::CONTEXT_PREFIX . '_' . $key . '=' . urlencode($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, '', false, false);
        } 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

Returns

bool

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

References $session, and ilSession\get().

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

    {
        $session = ilSession::get(self::SESSION_KEY);
        return isset($session[self::REFERER_KEY]) && strlen($session[self::REFERER_KEY]) ? true : false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setContextId()

static ilMailFormCall::setContextId (   $id )

static

Parameters

$id

string

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

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

Referenced by ilMailFormGUI\showForm().

    {
        $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

Parameters

array

$parameters

Returns

array

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

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

Referenced by ilMailFormGUI\showForm().

    {
        $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 )

static

Parameters

array

$recipients

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

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

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

    {
        $session = ilSession::get(self::SESSION_KEY);
        $session['rcp_to'] = $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 (   $request_params )

static

Parameters

array

$request_params

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

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

Referenced by ilMailGUI\executeCommand().

    {
        $session = ilSession::get(self::SESSION_KEY);
        if (isset($request_params[self::REFERER_KEY])) {
            $session[self::REFERER_KEY]   = base64_decode(rawurldecode($request_params[self::REFERER_KEY]));
            $session[self::SIGNATURE_KEY] = base64_decode(rawurldecode($request_params[self::SIGNATURE_KEY]));

            $ctx_params = array();
            foreach ($request_params as $key => $value) {
                $prefix = substr($key, 0, strlen(self::CONTEXT_PREFIX));
                if ($prefix == self::CONTEXT_PREFIX) {
                    if ($key == self::CONTEXT_KEY) {
                        $ctx_params[$key] = $value;
                    } else {
                        $ctx_params[substr($key, strlen(self::CONTEXT_PREFIX . '_'))] = $value;
                    }
                }
            }
            $session[self::CONTEXT_PREFIX] = $ctx_params;
        } else {
            unset($session[self::REFERER_KEY]);
            unset($session[self::SIGNATURE_KEY]);
            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'

Session parameter for the context.

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

Referenced by ilAppointmentPresentationCourseGUI\collectPropertiesAndActions(), ilMailMemberSearchGUI\generateContextArray(), ilObjCourseGUI\infoScreen(), ilLPTableBaseGUI\sendMail(), and ilMembershipGUI\sendMailToSelectedUsers().

CONTEXT_PREFIX

const ilMailFormCall::CONTEXT_PREFIX = 'ctx'

Session parameter for the context.

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

REFERER_KEY

const ilMailFormCall::REFERER_KEY = 'r'

HTTP-GET parameter for the referer url.

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

SESSION_KEY

const ilMailFormCall::SESSION_KEY = 'mail_transport'

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

SIGNATURE_KEY

const ilMailFormCall::SIGNATURE_KEY = 'sig'

Session parameter for the hash.

Definition at line 25 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