ilDiskQuotaReminderMail Class Reference

Class ilDiskQuotaReminderMail. More...

Collaboration diagram for ilDiskQuotaReminderMail:

Public Member Functions
	__construct ()
	constructor @access public More...
	useLangVariablesAsFallback ($a_status)
	areLangVariablesUsedAsFallback ()
	setData ($a_data)
	Sets used to fill in the placeholders in the mail. More...
	reset ()
	reset all values More...
	readMailTemplate ($a_lang)
	get new mail template array (including subject and message body) More...
	replacePlaceholders ($a_string, $a_amail, $a_lang)

Private Member Functions
	getLng ($a_lang)

Private Attributes
	$lang_variables_as_fallback = true
	$data
	Data used to fill in the placeholders in the mail. More...
	$tmp_lng

Detailed Description

Class ilDiskQuotaReminderMail.

Sends e-mail to users who have exceeded their disk quota.

Author

Werner Randelshofer werne.nosp@m.r.ra.nosp@m.ndels.nosp@m.hofe.nosp@m.r@hsl.nosp@m.u.ch

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilDiskQuotaReminderMail::__construct

(

)

constructor @access public

Definition at line 28 of file class.ilDiskQuotaReminderMail.php.

    {
    }

Member Function Documentation

areLangVariablesUsedAsFallback()

ilDiskQuotaReminderMail::areLangVariablesUsedAsFallback

(

)

Definition at line 37 of file class.ilDiskQuotaReminderMail.php.

    {
        return $this->lang_variables_as_fallback;
    }

References $lang_variables_as_fallback.

getLng()

ilDiskQuotaReminderMail::getLng (   $a_lang )

private

Definition at line 156 of file class.ilDiskQuotaReminderMail.php.

    {
        if ($this->tmp_lng == null || $this->tmp_lng->lang_key != $a_lang) {
            $this->tmp_lng = new ilLanguage($lang);
        }
        return $this->tmp_lng;
    }

References $lang, and $tmp_lng.

Referenced by replacePlaceholders().

Here is the caller graph for this function:

readMailTemplate()

ilDiskQuotaReminderMail::readMailTemplate

(

$a_lang

)

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

Definition at line 77 of file class.ilDiskQuotaReminderMail.php.

    {
        if (!is_array($this->amail[$a_lang])) {
            require_once('./Services/WebDAV/classes/class.ilObjDiskQuotaSettings.php');
            $this->amail[$a_lang] = ilObjDiskQuotaSettings::_lookupReminderMailTemplate($a_lang);
            $this->amail["body"] = trim($this->amail["body"]);
            $this->amail["subject"] = trim($this->amail["subject"]);
        }
 
        return $this->amail[$a_lang];
    }

References ilObjDiskQuotaSettings\_lookupReminderMailTemplate().

Here is the call graph for this function:

replacePlaceholders()

ilDiskQuotaReminderMail::replacePlaceholders	(		$a_string,
			$a_amail,
			$a_lang
	)

Definition at line 164 of file class.ilDiskQuotaReminderMail.php.

    {
        global $DIC;
 
        $tmp_lang = $this->getLng($a_lang);
        
        // determine salutation
        switch ($this->data['gender']) {
            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]", $this->data['login'], $a_string);
        $a_string = str_replace("[FIRST_NAME]", $this->data['firstname'], $a_string);
        $a_string = str_replace("[LAST_NAME]", $this->data['lastname'], $a_string);
        // BEGIN Mail Include E-Mail Address in account mail
        $a_string = str_replace("[EMAIL]", $this->data['email'], $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]",
            $DIC->settings()->get("admin_email"),
            $a_string
        );
 
        $a_string = str_replace("[DISK_QUOTA]", ilUtil::formatSize($this->data['disk_quota'], 'short', $tmp_lang), $a_string);
        $a_string = str_replace("[DISK_USAGE]", ilUtil::formatSize($this->data['disk_usage'], 'short', $tmp_lang), $a_string);
 
        $disk_usage_details = '';
        foreach ($this->data['disk_usage_details'] as $details) {
            $disk_usage_details .= number_format($details['count'], 0) . ' ' .
                $tmp_lang->txt($details['type']) . ' ' .
                ilUtil::formatSize($details['size'], 'short', $tmp_lang) . "\n";
        }
        $a_string = str_replace("[DISK_USAGE_DETAILS]", $disk_usage_details, $a_string);
            
        return $a_string;
    }

References $DIC, data, ilUtil\formatSize(), and getLng().

Here is the call graph for this function:

reset()

ilDiskQuotaReminderMail::reset

(

)

reset all values

Definition at line 69 of file class.ilDiskQuotaReminderMail.php.

    {
        unset($this->data);
    }

References data.

setData()

ilDiskQuotaReminderMail::setData

(

$a_data

)

Sets used to fill in the placeholders in the mail.

The following key value pairs must be supplied:

'language' string language of user 'gender' string gender of user 'm' or 'f' 'firstname' string firstname of the user 'lastname' string lastname of the user 'email' string email address of the user 'login' string login of the user 'disk_quota' integer disk quota in bytes of the user 'disk_usage' integer disk usage in bytes of the user 'disk_usage_details' associative array with the values returned by ilDiskQuotaChecker::_lookupDiskUsage($a_usr_id)

Parameters

$a_data

array Key value pairs with the name of the placeholder as keys.

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

    {
        $this->data = $a_data;
    }

References data.

useLangVariablesAsFallback()

ilDiskQuotaReminderMail::useLangVariablesAsFallback

(

$a_status

)

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

    {
        $this->lang_variables_as_fallback = $a_status;
    }

Field Documentation

$data

ilDiskQuotaReminderMail::$data

private

Data used to fill in the placeholders in the mail.

Contains key value pairs with the name of the placeholder as keys.

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

$lang_variables_as_fallback

ilDiskQuotaReminderMail::$lang_variables_as_fallback = true

private

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

Referenced by areLangVariablesUsedAsFallback().

$tmp_lng

ilDiskQuotaReminderMail::$tmp_lng

private

Definition at line 22 of file class.ilDiskQuotaReminderMail.php.

Referenced by getLng().

---

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

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