ilLMMailNotification Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilLMMailNotification:

Collaboration diagram for ilLMMailNotification:

Public Member Functions
	__construct (bool $a_is_personal_workspace=false)
	setQuestionId (int $a_val)
	getQuestionId ()
	send ()
Public Member Functions inherited from ilMailNotification
	__construct (protected bool $is_in_wsp=false)
	setType (int $a_type)
	getType ()
	setSender (int $a_usr_id)
	getSender ()
	setRecipients (array $a_rcp)
	getRecipients ()
	setAttachments (array $a_att)
	getAttachments ()
	setLangModules (array $a_modules)
	getUserLanguage (int $a_usr_id)
	setRefId (int $a_id)
	getRefId ()
	getObjId ()
	setObjId (int $a_obj_id)
	getObjType ()
	setAdditionalInformation (array $a_info)
	getAdditionalInformation ()
	sendMail (array $a_rcp, bool $a_parse_recipients=true)
	getBlockBorder ()

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

Protected Member Functions
	initLanguage (int $a_usr_id)
Protected Member Functions inherited from ilMailNotification
	setSubject (string $a_subject)
	getSubject ()
	setBody (string $a_body)
	appendBody (string $a_body)
	getBody ()
	initLanguage (int $a_usr_id)
	initLanguageByIso2Code (string $a_code='')
	setLanguage (ilLanguage $a_language)
	getLanguage ()
	getLanguageText (string $a_keyword)
	getObjectTitle (bool $a_shorten=false)
	initMail ()
	getMail ()
	createPermanentLink (array $a_params=[], string $a_append='')
	userToString (int $a_usr_id)
	isRefIdAccessible (int $a_user_id, int $a_ref_id, string $a_permission="read")

Protected Attributes
ILIAS TestQuestionPool Questions PublicInterface	$questioninfo
int	$question_id = 0
ilObjUser	$user
Protected Attributes inherited from ilMailNotification
int	$type
int	$sender
ilMail	$mail = null
string	$subject = ''
string	$body = ''
array	$attachments = []
ilLanguage	$language
array	$lang_modules = []
array	$recipients = []
int	$ref_id
int	$obj_id = 0
string	$obj_type = ''
array	$additional_info = []
ilWorkspaceTree	$wsp_tree
ilWorkspaceAccessHandler	$wsp_access_handler

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilLMMailNotification::__construct

(

bool

$a_is_personal_workspace = false

)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\user().

      {
        global $DIC;
        parent::__construct($a_is_personal_workspace);
        $this->user = $DIC->user();
        $this->questioninfo = $DIC->testQuestion();
    }

Here is the call graph for this function:

Member Function Documentation

getQuestionId()

ilLMMailNotification::getQuestionId

(

)

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

References $question_id.

                                   : int
    {
        return $this->question_id;
    }

initLanguage()

ilLMMailNotification::initLanguage ( int  $a_usr_id )

protected

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

References ilMailNotification\getLanguage().

Referenced by send().

                                                  : void
    {
        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

(

)

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

References $user, ilMailNotification\appendBody(), ilMailNotification\createPermanentLink(), ilMailNotification\getLanguage(), ilMailNotification\getLanguageText(), ilMailNotification\getMail(), ilUserUtil\getNamePresentation(), ilMailNotification\getObjectTitle(), ilMailNotification\getRecipients(), ilMail\getSalutation(), ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), ilMailNotification\getType(), initLanguage(), ilMailNotification\initMail(), ilMailNotification\sendMail(), ilMailNotification\setBody(), and ilMailNotification\setSubject().

                          : bool
    {
        $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");
                    $this->appendBody(
                        $this->getLanguageText('user') . ": " . ilUserUtil::getNamePresentation($ilUser->getId(), false, false, "")
                    );
                    $this->appendBody("\n");

                    $this->appendBody(
                        $this->getLanguageText('question') . ": " . $this->questioninfo->getGeneralQuestionProperties($this->getQuestionId())->getTitle()
                    );
                    $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));
                }
                break;
        }
        return true;
    }

Here is the call graph for this function:

setQuestionId()

ilLMMailNotification::setQuestionId

(

int

$a_val

)

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

                                             : void
    {
        $this->question_id = $a_val;
    }

Field Documentation

$question_id

int ilLMMailNotification::$question_id = 0

protected

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

Referenced by getQuestionId().

$questioninfo

ILIAS TestQuestionPool Questions PublicInterface ilLMMailNotification::$questioninfo

protected

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

$user

ilObjUser ilLMMailNotification::$user

protected

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

Referenced by send().

TYPE_USER_BLOCKED

const ilLMMailNotification::TYPE_USER_BLOCKED = 10

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

Referenced by ilLMPageGUI\processAnswer().

---

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

• components/ILIAS/LearningModule/classes/class.ilLMMailNotification.php