ilMailFormCall Class Reference

Collaboration diagram for ilMailFormCall:

Static Public Member Functions
static	_getLinkTarget ($gui, $cmd, $gui_params=array(), $mail_params=array())
static	_getRedirectTarget ($gui, $cmd, $gui_params=array(), $mail_params=array())
static	_storeReferer ($request_params)
static	_getSignature ()
	Get preset signature.
static	_getRefererRedirectUrl ()
static	_isRefererStored ()

Data Fields
const	REFERER_KEY = 'r'
const	SIGNATURE_KEY = 'sig'

Detailed Description

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

Member Function Documentation

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

static

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

References $cmd, and $ilCtrl.

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

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

        if(is_object($gui))
        {
            global $ilCtrl;
            $ilCtrlTmp = clone $ilCtrl;
            foreach($gui_params as $key => $value)
            {
                $ilCtrlTmp->setParameter($gui, $key, $value);
            }
            $referer = $ilCtrlTmp->getLinkTarget($gui, $cmd, '', false, false);
        }
        else if(is_string($gui))
        {
            $referer = $gui;
        }

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

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

Here is the caller graph for this function:

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

static

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

References $cmd, and $ilCtrl.

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

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

        if(is_object($gui))
        {
            global $ilCtrl;
            $ilCtrlTmp = clone $ilCtrl;
            foreach($gui_params as $key => $value)
            {
                $ilCtrlTmp->setParameter($gui, $key, $value);
            }
            $referer = $ilCtrlTmp->getLinkTarget($gui, $cmd, '', false, false);
        }
        else if(is_string($gui))
        {
            $referer = $gui;
        }

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

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

Here is the caller graph for this function:

static ilMailFormCall::_getRefererRedirectUrl ( )

static

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

References $_SESSION, and REFERER_KEY.

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:

static ilMailFormCall::_getSignature ( )

static

Get preset signature.

Returns

string signature

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

References $_SESSION, and SIGNATURE_KEY.

Referenced by ilMailFormGUI\showForm().

        {
                $sig = $_SESSION[self::SIGNATURE_KEY];
                
                unset($_SESSION[self::SIGNATURE_KEY]);
                
                return $sig;
        }

Here is the caller graph for this function:

static ilMailFormCall::_isRefererStored ( )

static

Definition at line 112 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:

static ilMailFormCall::_storeReferer (   $request_params )

static

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

References $_SESSION, REFERER_KEY, and SIGNATURE_KEY.

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

const ilMailFormCall::REFERER_KEY = 'r'

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

Referenced by _getRefererRedirectUrl(), and _storeReferer().

const ilMailFormCall::SIGNATURE_KEY = 'sig'

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

Referenced by _getSignature(), and _storeReferer().

---

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

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