ilAccountMail Class Reference

Class ilAccountMail. More...

Collaboration diagram for ilAccountMail:

Public Member Functions
	__construct ()
	constructor public More...
	useLangVariablesAsFallback ($a_status)
	areLangVariablesUsedAsFallback ()
	shouldAttachConfiguredFiles ()
	setAttachConfiguredFiles (bool $attachConfiguredFiles)
	setUserPassword ($a_pwd)
	set user password More...
	getUserPassword ()
	get user password More...
	setUser (&$a_user)
	Set user. More...
&	getUser ()
	get user object More...
	setTarget ($a_target)
	set repository item target More...
	getTarget ()
	get target More...
	reset ()
	reset all values More...
	readAccountMail ($a_lang)
	get new account mail array (including subject and message body) More...
	replacePlaceholders ($a_string, &$a_user, $a_amail, $a_lang)
	addAttachment ($a_filename, $a_display_name)

Data Fields
	$u_password = ""
	$user = ""
	$target = ""

Private Member Functions
	addAttachments ($mailData)

Private Attributes
	$lang_variables_as_fallback = false
	$attachments = array()
	$attachConfiguredFiles = false

Detailed Description

Class ilAccountMail.

Sends e-mail to newly created accounts.

Author

Stefan Schneider stefa.nosp@m.n.sc.nosp@m.hneid.nosp@m.er@h.nosp@m.rz.un.nosp@m.i-gi.nosp@m.essen.nosp@m..de

Alex Killing alex..nosp@m.kill.nosp@m.ing@h.nosp@m.rz.u.nosp@m.ni-gi.nosp@m.esse.nosp@m.n.de

Definition at line 13 of file class.ilAccountMail.php.

Constructor & Destructor Documentation

__construct()

ilAccountMail::__construct

(

)

constructor public

Definition at line 47 of file class.ilAccountMail.php.

    {
    }

Member Function Documentation

addAttachment()

ilAccountMail::addAttachment	(		$a_filename,
			$a_display_name
	)

Definition at line 387 of file class.ilAccountMail.php.

Referenced by addAttachments().

    {
        $this->attachments[$a_filename] = $a_display_name;
    }

Here is the caller graph for this function:

addAttachments()

ilAccountMail::addAttachments (   $mailData )

private

Definition at line 180 of file class.ilAccountMail.php.

References $filename, $GLOBALS, $ilSetting, $lang, $user, addAttachment(), areLangVariablesUsedAsFallback(), ilDatePresentation\formatPeriod(), getUser(), IL_CAL_UNIX, readAccountMail(), replacePlaceholders(), shouldAttachConfiguredFiles(), and USER_FOLDER_ID.

    {
        if ($this->shouldAttachConfiguredFiles() && isset($mailData['att_file'])) {
            $fs = new ilFSStorageUserFolder(USER_FOLDER_ID);
            $fs->create();

            $pathToFile = '/' . implode('/', array_map(function ($pathPart) {
                return trim($pathPart, '/');
            }, [
                    $fs->getAbsolutePath(),
                    $mailData['lang'],
                ]));

            $this->addAttachment($pathToFile, $mailData['att_file']);
        }
    }

Here is the call graph for this function:

areLangVariablesUsedAsFallback()

ilAccountMail::areLangVariablesUsedAsFallback

(

)

Definition at line 56 of file class.ilAccountMail.php.

References $lang_variables_as_fallback.

Referenced by addAttachments().

    {
        return $this->lang_variables_as_fallback;
    }

Here is the caller graph for this function:

getTarget()

ilAccountMail::getTarget

(

)

get target

public

Returns

string repository item target

Definition at line 147 of file class.ilAccountMail.php.

References $target.

    {
        return $this->target;
    }

getUser()

& ilAccountMail::getUser

(

)

get user object

public

Returns

object user object

Definition at line 125 of file class.ilAccountMail.php.

References $user.

Referenced by addAttachments().

    {
        return $this->user;
    }

Here is the caller graph for this function:

getUserPassword()

ilAccountMail::getUserPassword

(

)

get user password

public

Returns

string users password as plain text

Definition at line 94 of file class.ilAccountMail.php.

References $u_password.

Referenced by replacePlaceholders().

    {
        return $this->u_password;
    }

Here is the caller graph for this function:

readAccountMail()

ilAccountMail::readAccountMail

(

$a_lang

)

get new account mail array (including subject and message body)

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

References ilObjUserFolder\_lookupNewAccountMail().

Referenced by addAttachments().

    {
        if (!is_array($this->amail[$a_lang])) {
            include_once('./Services/User/classes/class.ilObjUserFolder.php');
            $this->amail[$a_lang] = ilObjUserFolder::_lookupNewAccountMail($a_lang);
            $amail["body"] = trim($amail["body"]);
            $amail["subject"] = trim($amail["subject"]);
        }

        return $this->amail[$a_lang];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

replacePlaceholders()

ilAccountMail::replacePlaceholders	(		$a_string,
		&	$a_user,
			$a_amail,
			$a_lang
	)

Definition at line 288 of file class.ilAccountMail.php.

References $_GET, $ilSetting, $tree, $type, ilLanguage\_lookupEntry(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilDatePresentation\formatPeriod(), getUserPassword(), and IL_CAL_UNIX.

Referenced by addAttachments().

    {
        global $ilSetting, $tree;
        
        // determine salutation
        switch ($a_user->getGender()) {
            case "f":   $gender_salut = $a_amail["sal_f"];
                        break;
            case "m":   $gender_salut = $a_amail["sal_m"];
                        break;
            default:    $gender_salut = $a_amail["sal_g"];
        }
        $gender_salut = trim($gender_salut);

        $a_string = str_replace("[MAIL_SALUTATION]", $gender_salut, $a_string);
        $a_string = str_replace("[LOGIN]", $a_user->getLogin(), $a_string);
        $a_string = str_replace("[FIRST_NAME]", $a_user->getFirstname(), $a_string);
        $a_string = str_replace("[LAST_NAME]", $a_user->getLastname(), $a_string);
        // BEGIN Mail Include E-Mail Address in account mail
        $a_string = str_replace("[EMAIL]", $a_user->getEmail(), $a_string);
        // END Mail Include E-Mail Address in account mail
        $a_string = str_replace("[PASSWORD]", $this->getUserPassword(), $a_string);
        $a_string = str_replace(
            "[ILIAS_URL]",
            ILIAS_HTTP_PATH . "/login.php?client_id=" . CLIENT_ID,
            $a_string
        );
        $a_string = str_replace("[CLIENT_NAME]", CLIENT_NAME, $a_string);
        $a_string = str_replace(
            "[ADMIN_MAIL]",
            $ilSetting->get("admin_email"),
            $a_string
        );
            
        // (no) password sections
        if ($this->getUserPassword() == "") {
            // #12232
            $a_string = preg_replace("/\[IF_PASSWORD\].*\[\/IF_PASSWORD\]/imsU", "", $a_string);
            $a_string = preg_replace("/\[IF_NO_PASSWORD\](.*)\[\/IF_NO_PASSWORD\]/imsU", "$1", $a_string);
        } else {
            $a_string = preg_replace("/\[IF_NO_PASSWORD\].*\[\/IF_NO_PASSWORD\]/imsU", "", $a_string);
            $a_string = preg_replace("/\[IF_PASSWORD\](.*)\[\/IF_PASSWORD\]/imsU", "$1", $a_string);
        }
                
        // #13346
        if (!$a_user->getTimeLimitUnlimited()) {
            // #6098
            $a_string = preg_replace("/\[IF_TIMELIMIT\](.*)\[\/IF_TIMELIMIT\]/imsU", "$1", $a_string);
            $timelimit_from = new ilDateTime($a_user->getTimeLimitFrom(), IL_CAL_UNIX);
            $timelimit_until = new ilDateTime($a_user->getTimeLimitUntil(), IL_CAL_UNIX);
            $timelimit = ilDatePresentation::formatPeriod($timelimit_from, $timelimit_until);
            $a_string = str_replace("[TIMELIMIT]", $timelimit, $a_string);
        } else {
            $a_string = preg_replace("/\[IF_TIMELIMIT\](.*)\[\/IF_TIMELIMIT\]/imsU", "", $a_string);
        }
        
        // target
        $tar = false;
        if ($_GET["target"] != "") {
            $tarr = explode("_", $_GET["target"]);
            if ($tree->isInTree($tarr[1])) {
                $obj_id = ilObject::_lookupObjId($tarr[1]);
                $type = ilObject::_lookupType($obj_id);
                if ($type == $tarr[0]) {
                    $a_string = str_replace(
                        "[TARGET_TITLE]",
                        ilObject::_lookupTitle($obj_id),
                        $a_string
                    );
                    $a_string = str_replace(
                        "[TARGET]",
                        ILIAS_HTTP_PATH . "/goto.php?client_id=" . CLIENT_ID . "&target=" . $_GET["target"],
                        $a_string
                    );
                        
                    // this looks complicated, but we may have no initilised $lng object here
                    // if mail is send during user creation in authentication
                    include_once("./Services/Language/classes/class.ilLanguage.php");
                    $a_string = str_replace(
                        "[TARGET_TYPE]",
                        ilLanguage::_lookupEntry($a_lang, "common", "obj_" . $tarr[0]),
                        $a_string
                    );
                        
                    $tar = true;
                }
            }
        }

        // (no) target section
        if (!$tar) {
            $a_string = preg_replace("/\[IF_TARGET\].*\[\/IF_TARGET\]/imsU", "", $a_string);
        } else {
            $a_string = preg_replace("/\[IF_TARGET\](.*)\[\/IF_TARGET\]/imsU", "$1", $a_string);
        }

        return $a_string;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

reset()

ilAccountMail::reset

(

)

reset all values

Definition at line 155 of file class.ilAccountMail.php.

References user().

    {
        unset($this->u_password);
        unset($this->user);
        unset($this->target);
    }

Here is the call graph for this function:

setAttachConfiguredFiles()

ilAccountMail::setAttachConfiguredFiles

(

bool

$attachConfiguredFiles

)

Parameters

bool

$attachConfiguredFiles

Definition at line 72 of file class.ilAccountMail.php.

References $attachConfiguredFiles.

    {
        $this->attachConfiguredFiles = $attachConfiguredFiles;
    }

setTarget()

ilAccountMail::setTarget

(

$a_target

)

set repository item target

public

Parameters

string

$a_target

target as used in permanent links, e.g. crs_123

Definition at line 136 of file class.ilAccountMail.php.

    {
        $this->u_target = $a_target;
    }

setUser()

ilAccountMail::setUser

(

&

$a_user

)

Set user.

The user object should provide email, language login, gender, first and last name

public

Parameters

object

$a_user

user object

Definition at line 106 of file class.ilAccountMail.php.

References ilObject\getId(), and user().

    {
        if (
            $this->user instanceof ilObjUser &&
            $a_user instanceof ilObjUser &&
            $a_user->getId() != $this->user->getId()
        ) {
            $this->attachments = [];
        }

        $this->user = &$a_user;
    }

Here is the call graph for this function:

setUserPassword()

ilAccountMail::setUserPassword

(

$a_pwd

)

set user password

public

Parameters

string

$a_pwd

users password as plain text

Definition at line 83 of file class.ilAccountMail.php.

    {
        $this->u_password = $a_pwd;
    }

shouldAttachConfiguredFiles()

ilAccountMail::shouldAttachConfiguredFiles

(

)

Returns

bool

Definition at line 64 of file class.ilAccountMail.php.

References $attachConfiguredFiles.

Referenced by addAttachments().

                                                  : bool
    {
        return $this->attachConfiguredFiles;
    }

Here is the caller graph for this function:

useLangVariablesAsFallback()

ilAccountMail::useLangVariablesAsFallback

(

$a_status

)

Definition at line 51 of file class.ilAccountMail.php.

    {
        $this->lang_variables_as_fallback = $a_status;
    }

Field Documentation

$attachConfiguredFiles

ilAccountMail::$attachConfiguredFiles = false

private

Definition at line 41 of file class.ilAccountMail.php.

Referenced by setAttachConfiguredFiles(), and shouldAttachConfiguredFiles().

$attachments

ilAccountMail::$attachments = array()

private

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

$lang_variables_as_fallback

ilAccountMail::$lang_variables_as_fallback = false

private

Definition at line 36 of file class.ilAccountMail.php.

Referenced by areLangVariablesUsedAsFallback().

$target

ilAccountMail::$target = ""

Definition at line 34 of file class.ilAccountMail.php.

Referenced by getTarget().

$u_password

ilAccountMail::$u_password = ""

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

Referenced by getUserPassword().

$user

ilAccountMail::$user = ""

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

Referenced by addAttachments(), and getUser().

---

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

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