ilLMMailNotification Class Reference

Inheritance diagram for ilLMMailNotification:

Collaboration diagram for ilLMMailNotification:

Public Member Functions
	__construct ($a_is_personal_workspace=false)
	Constructor. More...
	setQuestionId ($a_val)
	Set question id. More...
	getQuestionId ()
	Get question id. More...
	send ()
	Send notifications. More...
Public Member Functions inherited from ilMailNotification
	__construct ($a_is_personal_workspace=false)
	setType ($a_type)
	Set notification type. More...
	getType ()
	Get notification type. More...
	setSender ($a_usr_id)
	Set sender of mail. More...
	getSender ()
	get sender of mail More...
	setRecipients (array $a_rcp)
	getRecipients ()
	get array of recipients More...
	setAttachments ($a_att)
	Set attachments. More...
	getAttachments ()
	Get attachments. More...
	setLangModules (array $a_modules)
	Set lang modules. More...
	getUserLanguage ($a_usr_id)
	Get user language. More...
	setRefId ($a_id)
	getRefId ()
	getObjId ()
	setObjId ($a_obj_id)
	getObjType ()
	Get object type. More...
	setAdditionalInformation (array $a_info)
	Additional information for creating notification mails. More...
	getAdditionalInformation ()
	sendMail (array $a_rcp, $a_type, $a_parse_recipients=true)
	getBlockBorder ()
	Get (ascii) block border. More...

Data Fields
const	TYPE_USER_BLOCKED = 10
Data Fields inherited from ilMailNotification
const	SUBJECT_TITLE_LENGTH = 60

Protected Member Functions
	initLanguage ($a_usr_id)
	Init language. More...
Protected Member Functions inherited from ilMailNotification
	setSubject ($a_subject)
	getSubject ()
	setBody ($a_body)
	appendBody ($a_body)
	Append body text. More...
	getBody ()
	initLanguage ($a_usr_id)
	Init language. More...
	initLanguageByIso2Code ($a_code='')
	Init language by ISO2 code. More...
	setLanguage ($a_language)
	getLanguage ()
	getLanguageText ($a_keyword)
	getObjectTitle ($a_shorten=false)
	initMail ()
	getMail ()
	createPermanentLink ($a_params=array(), $a_append='')
	userToString ($a_usr_id)
	isRefIdAccessible ($a_user_id, $a_ref_id, $a_permission="read")
	Check if ref id is accessible for user. More...

Protected Attributes
	$user
Protected Attributes inherited from ilMailNotification
	$type = null
	$sender = null
	$mail = null
	$subject = ''
	$body = ''
	$attachments = array()
	$language = null
	$lang_modules = array()
	$recipients = array()
	$ref_id = null
	$obj_id = null
	$obj_type = null
	$additional_info = array()
	$is_in_wsp
	$wsp_tree
	$wsp_access_handler

Detailed Description

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 12 of file class.ilLMMailNotification.php.

Constructor & Destructor Documentation

__construct()

ilLMMailNotification::__construct

(

$a_is_personal_workspace = false

)

Constructor.

Definition at line 23 of file class.ilLMMailNotification.php.

References $DIC, and user().

    {
        global $DIC;
        parent::__construct($a_is_personal_workspace);

        $this->user = $DIC->user();
    }

Here is the call graph for this function:

Member Function Documentation

getQuestionId()

ilLMMailNotification::getQuestionId

(

)

Get question id.

Returns

int question id

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

Referenced by send().

    {
        return $this->question_id;
    }

Here is the caller graph for this function:

initLanguage()

ilLMMailNotification::initLanguage (   $a_usr_id )

protected

Init language.

Parameters

int

$a_usr_id

user id

Definition at line 116 of file class.ilLMMailNotification.php.

References ilMailNotification\getLanguage().

Referenced by send().

    {
        parent::initLanguage($a_usr_id);
        $this->getLanguage()->loadLanguageModule('content');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

send()

ilLMMailNotification::send

(

)

Send notifications.

Returns

Definition at line 57 of file class.ilLMMailNotification.php.

References $ilUser, $user, assQuestion\_getTitle(), ilMailNotification\appendBody(), ilMailNotification\createPermanentLink(), ilMailNotification\getLanguage(), ilMailNotification\getLanguageText(), ilMailNotification\getMail(), ilUserUtil\getNamePresentation(), ilMailNotification\getObjectTitle(), getQuestionId(), ilMailNotification\getRecipients(), ilMail\getSalutation(), ilMailNotification\getType(), initLanguage(), ilMailNotification\initMail(), ilMailNotification\sendMail(), ilMailNotification\setBody(), and ilMailNotification\setSubject().

    {
        $ilUser = $this->user;
        
        switch ($this->getType()) {
            case self::TYPE_USER_BLOCKED:
                
                foreach ($this->getRecipients() as $rcp) {
                    $this->initLanguage($rcp);
                    $this->initMail();
                    $this->setSubject(
                        sprintf(
                            $this->getLanguageText('cont_user_blocked'),
                            $this->getObjectTitle(true)
                        )
                    );
                    $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                    $this->appendBody("\n\n");
                    $this->appendBody(
                        $this->getLanguageText('cont_user_blocked2')
                    );
                    $this->appendBody("\n");
                    $this->appendBody(
                        $this->getLanguageText('cont_user_blocked3') . " '" . $this->getLanguageText('objs_qst') . "' > '" . $this->getLanguageText('cont_blocked_users') . "'"
                    );
                    $this->appendBody("\n");
                    $this->appendBody(
                        $this->getLanguageText('obj_lm') . ": " . $this->getObjectTitle(true)
                    );
                    $this->appendBody("\n");
                    include_once("./Services/User/classes/class.ilUserUtil.php");
                    $this->appendBody(
                        $this->getLanguageText('user') . ": " . ilUserUtil::getNamePresentation($ilUser->getId(), false, false, "")
                    );
                    $this->appendBody("\n");

                    include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
                    $this->appendBody(
                        $this->getLanguageText('question') . ": " . assQuestion::_getTitle($this->getQuestionId())
                    );
                    $this->appendBody("\n");
                    $this->appendBody("\n\n");
                    $this->appendBody($this->getLanguageText('cont_lm_mail_permanent_link'));
                    $this->appendBody("\n");
                    $this->appendBody($this->createPermanentLink(array(), ""));
                    $this->getMail()->appendInstallationSignature(true);
                    $this->sendMail(array($rcp), array('system'));
                }
                break;

        }
        return true;
    }

Here is the call graph for this function:

setQuestionId()

ilLMMailNotification::setQuestionId

(

$a_val

)

Set question id.

Parameters

int

$a_val

question id

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

    {
        $this->question_id = $a_val;
    }

Field Documentation

$user

ilLMMailNotification::$user

protected

Definition at line 17 of file class.ilLMMailNotification.php.

Referenced by send().

TYPE_USER_BLOCKED

const ilLMMailNotification::TYPE_USER_BLOCKED = 10

Definition at line 31 of file class.ilLMMailNotification.php.

Referenced by ilLMPageGUI\processAnswer().

---

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

• Modules/LearningModule/classes/class.ilLMMailNotification.php