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())
static	getRedirectTarget ($gui, $cmd, Array $gui_params=array(), Array $mail_params=array())
static	storeReferer ($request_params)
static	getSignature ()
	Get preset signature. More...
static	getRefererRedirectUrl ()
static	isRefererStored ()
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...

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

getLinkTarget()

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

static

Parameters

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

Returns

string

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

References $cmd.

Referenced by ilAssignedUsersTableGUI\fillRow(), ilUsersOnlineBlockGUI\fillRow(), ilPublicUserProfileGUI\getEmbeddable(), ilObjCourseGUI\infoScreen(), ilObjiLincCourseGUI\mailMembersObject(), ilObjGroupGUI\mailMembersObject(), ilObjCourseGUI\mailMembersObject(), ilObjiLincCourseGUI\membersObject(), and ilPaymentTrusteeGUI\showTrustees().

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

Here is the caller graph for this function:

getRecipients()

static ilMailFormCall::getRecipients ( )

static

Returns

array

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

References 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()  )

static

Parameters

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

Returns

string

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

References $cmd, and $ilCtrl.

Referenced by ilObjRoleGUI\mailToRoleObject(), ilObjExerciseGUI\redirectFeedbackMailObject(), ilBookmarkAdministrationGUI\sendmail(), ilObjContentObjectGUI\sendMailToBlockedUsers(), ilMembershipGUI\sendMailToSelectedUsers(), ilObjCourseGUI\sendMailToSelectedUsersObject(), and ilObjGroupGUI\sendMailToSelectedUsersObject().

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

Here is the caller graph for this function:

getRefererRedirectUrl()

static ilMailFormCall::getRefererRedirectUrl ( )

static

Returns

string

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

References $_SESSION.

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

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

                return $url;
        }

Here is the caller graph for this function:

getSignature()

static ilMailFormCall::getSignature ( )

static

Get preset signature.

Returns

string signature

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

References $_SESSION.

Referenced by ilMailFormGUI\showForm().

        {
                $sig = $_SESSION[self::SIGNATURE_KEY];

                unset($_SESSION[self::SIGNATURE_KEY]);

                return $sig;
        }

Here is the caller graph for this function:

isRefererStored()

static ilMailFormCall::isRefererStored ( )

static

Returns

bool

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

References $_SESSION.

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

        {
                return isset($_SESSION[self::REFERER_KEY]) && strlen($_SESSION[self::REFERER_KEY]) ? true : false;
        }

Here is the caller graph for this function:

setRecipients()

static ilMailFormCall::setRecipients ( array  $recipients )

static

Parameters

array

$recipients

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

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

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

        {
                $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 99 of file class.ilMailFormCall.php.

References $_SESSION.

Referenced by ilMailGUI\executeCommand().

        {
                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]));
                }
                else
                {
                        unset($_SESSION[self::REFERER_KEY]);
                        unset($_SESSION[self::SIGNATURE_KEY]);
                }
        }

Here is the caller graph for this function:

Field Documentation

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.

---

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

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