Base class for course/group mail notifications. More...

Inheritance diagram for ilMailNotification:

Collaboration diagram for ilMailNotification:

Public Member Functions
	__construct ()
	Constructor.
	setType ($a_type)
	Set notification type.
	getType ()
	Get notification type.
	setSender ($a_usr_id)
	Set sender of mail.
	getSender ()
	get sender of mail
	setRecipients ($a_rcp)
	set mail recipients
	getRecipients ()
	get array of recipients
	setRefId ($a_id)
	Set ref id.
	getRefId ()
	get reference id
	getObjId ()
	get object id
	setObjId ($a_obj_id)
	set obj id
	getObjType ()
	Get object type.
	setAdditionalInformation ($a_info)
	Additional information for creating notification mails.
	getAdditionalInformation ()
	Get additional information for generating notification mails.
	send ()
	Send notifications.
	sendMail ($a_rcp, $a_type, $a_parse_recipients=true)
	Send Mail.

Data Fields
const	SUBJECT_TITLE_LENGTH = 60

Protected Member Functions
	setSubject ($a_subject)
	Set mail subject.
	getSubject ()
	Get mail subject.
	setBody ($a_body)
	Set mail body.
	appendBody ($a_body)
	Append body text.
	getBody ()
	Get body.
	initLanguage ($a_usr_id)
	Init language.
	setLanguage ($a_language)
	A language.
	getLanguage ()
	get language object
	getLanguageText ($a_keyword)
	Replace new lines.
	getObjectTitle ($a_shorten=false)
	Get object title.
	initMail ()
	Init mail.
	getMail ()
	Get mail object.
	createPermanentLink ($a_params=array(), $a_append= '')
	Create a permanent link for an object.
	userToString ($a_usr_id)
	Utility function.

Private Attributes
	$type = null
	$sender = null
	$mail = null
	$subject = ''
	$body = ''
	$language = null
	$recipients = array()
	$ref_id = null
	$obj_id = null
	$obj_type = null
	$additional_info = array()

Detailed Description

Base class for course/group mail notifications.

Version: $Id$

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 16 of file class.ilMailNotification.php.

Constructor & Destructor Documentation

ilMailNotification::__construct ( )

Constructor.

Returns

Reimplemented in ilCalendarMailNotification, ilCourseMembershipMailNotification, ilGroupMembershipMailNotification, ilRegistrationMailNotification, ilDiskQuotaSummaryNotification, ilExerciseMailNotification, and ilMailSummaryNotification.

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

References $lng, ilLanguageFactory\_getLanguage(), and setSender().

        {
                global $lng;
                $this->setSender(ANONYMOUS_USER_ID);
                $this->language = ilLanguageFactory::_getLanguage($lng->getDefaultLanguage());
        }

Here is the call graph for this function:

Member Function Documentation

ilMailNotification::appendBody ( $a_body )

protected

Append body text.

Parameters

string $a_body

Returns: string body

Definition at line 121 of file class.ilMailNotification.php.

Referenced by ilCalendarMailNotification\appendAppointmentDetails(), ilMailSummaryNotification\send(), ilRegistrationMailNotification\send(), ilCourseMembershipMailNotification\send(), ilGroupMembershipMailNotification\send(), ilDiskQuotaSummaryNotification\send(), ilExerciseMailNotification\send(), and ilCalendarMailNotification\send().

        {
                return $this->body .= $a_body;
        }

Here is the caller graph for this function:

ilMailNotification::createPermanentLink	(	$a_params = `array()`,
		$a_append = `''`
	)

protected

Create a permanent link for an object.

Returns

Definition at line 347 of file class.ilMailNotification.php.

References ilLink\_getLink(), getObjType(), and getRefId().

Referenced by ilCourseMembershipMailNotification\send(), ilGroupMembershipMailNotification\send(), ilExerciseMailNotification\send(), and ilCalendarMailNotification\send().

        {
                include_once './classes/class.ilLink.php';
                
                if($this->getRefId())
                {
                        return ilLink::_getLink($this->ref_id,$this->getObjType(),$a_params,$a_append);
                }
                else
                {
                        // Return root
                        return ilLink::_getLink(ROOT_FOLDER_ID,'root');
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilMailNotification::getAdditionalInformation ( )

Get additional information for generating notification mails.

Returns

Definition at line 256 of file class.ilMailNotification.php.

References $additional_info.

Referenced by ilRegistrationMailNotification\send(), ilCourseMembershipMailNotification\send(), and ilGroupMembershipMailNotification\send().

        {
                return (array) $this->additional_info; 
        }

Here is the caller graph for this function:

ilMailNotification::getBody ( )

protected

Get body.

Returns: string

Definition at line 130 of file class.ilMailNotification.php.

References $body.

Referenced by ilMailSummaryNotification\send(), and sendMail().

        {
                return $this->body;
        }

Here is the caller graph for this function:

ilMailNotification::getLanguage ( )

protected

get language object

Returns

Definition at line 179 of file class.ilMailNotification.php.

References $language.

Referenced by getLanguageText(), ilRegistrationMailNotification\initLanguage(), ilExerciseMailNotification\initLanguage(), ilGroupMembershipMailNotification\initLanguage(), ilCourseMembershipMailNotification\initLanguage(), ilMailSummaryNotification\send(), ilRegistrationMailNotification\send(), ilCourseMembershipMailNotification\send(), ilGroupMembershipMailNotification\send(), ilDiskQuotaSummaryNotification\send(), ilExerciseMailNotification\send(), and ilCalendarMailNotification\send().

        {
                return $this->language;
        }

Here is the caller graph for this function:

ilMailNotification::getLanguageText ( $a_keyword )

protected

Replace new lines.

Parameters

object $a_keyword

Returns

Definition at line 189 of file class.ilMailNotification.php.

References getLanguage().

Referenced by ilCourseMembershipMailNotification\createCourseStatus(), ilGroupMembershipMailNotification\createGroupStatus(), ilMailSummaryNotification\send(), ilRegistrationMailNotification\send(), ilCourseMembershipMailNotification\send(), ilGroupMembershipMailNotification\send(), ilExerciseMailNotification\send(), and ilCalendarMailNotification\send().

        {
                return str_replace('\n', "\n", $this->getLanguage()->txt($a_keyword));
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilMailNotification::getMail ( )

protected

Get mail object.

Returns

Definition at line 338 of file class.ilMailNotification.php.

References initMail().

Referenced by ilRegistrationMailNotification\send(), ilGroupMembershipMailNotification\send(), ilCourseMembershipMailNotification\send(), ilDiskQuotaSummaryNotification\send(), ilExerciseMailNotification\send(), ilCalendarMailNotification\send(), and sendMail().

        {
                return is_object($this->mail) ? $this->mail : $this->initMail();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilMailNotification::getObjectTitle ( $a_shorten = false )

protected

Get object title.

Parameters

bool	shorten title

Returns

Definition at line 266 of file class.ilMailNotification.php.

References ilObject\_lookupTitle(), getObjId(), and ilUtil\shortenText().

Referenced by ilCourseMembershipMailNotification\send(), ilGroupMembershipMailNotification\send(), ilExerciseMailNotification\send(), and ilCalendarMailNotification\send().

        {
                if(!$this->getObjId())
                {
                        return '';
                }
                return ilUtil::shortenText(ilObject::_lookupTitle($this->getObjId()), self::SUBJECT_TITLE_LENGTH,true);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilMailNotification::getObjId ( )

get object id

Returns

Definition at line 219 of file class.ilMailNotification.php.

References $obj_id.

Referenced by ilCourseMembershipMailNotification\createCourseStatus(), ilGroupMembershipMailNotification\createGroupStatus(), and getObjectTitle().

        {
                return $this->obj_id;
        }

Here is the caller graph for this function:

ilMailNotification::getObjType ( )

Get object type.

Returns

Definition at line 237 of file class.ilMailNotification.php.

References $obj_type.

Referenced by createPermanentLink().

        {
                return $this->obj_type;
        }

Here is the caller graph for this function:

ilMailNotification::getRecipients ( )

get array of recipients

Returns

Definition at line 149 of file class.ilMailNotification.php.

References $recipients.

Referenced by ilRegistrationMailNotification\send(), ilGroupMembershipMailNotification\send(), ilCourseMembershipMailNotification\send(), ilDiskQuotaSummaryNotification\send(), ilExerciseMailNotification\send(), and ilCalendarMailNotification\send().

        {
                return $this->recipients;
        }

Here is the caller graph for this function:

ilMailNotification::getRefId ( )

get reference id

Returns

Definition at line 210 of file class.ilMailNotification.php.

References $ref_id.

Referenced by createPermanentLink(), and ilCalendarMailNotification\send().

        {
                return $this->ref_id;
        }

Here is the caller graph for this function:

ilMailNotification::getSender ( )

get sender of mail

Returns

Definition at line 82 of file class.ilMailNotification.php.

References $sender.

Referenced by initMail().

        {
                return $this->sender;
        }

Here is the caller graph for this function:

ilMailNotification::getSubject ( )

protected

Get mail subject.

Returns: string

Definition at line 101 of file class.ilMailNotification.php.

References $subject.

Referenced by ilMailSummaryNotification\send(), and sendMail().

        {
                return $this->subject;
        }

Here is the caller graph for this function:

ilMailNotification::getType ( )

Get notification type.

Returns

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

References $type.

Referenced by ilRegistrationMailNotification\send(), ilGroupMembershipMailNotification\send(), ilCourseMembershipMailNotification\send(), ilExerciseMailNotification\send(), ilCalendarMailNotification\send(), and send().

        {
                return $this->type;
        }

Here is the caller graph for this function:

ilMailNotification::initLanguage ( $a_usr_id )

protected

Init language.

Parameters

int $a_usr_id

Returns

Reimplemented in ilCourseMembershipMailNotification, ilGroupMembershipMailNotification, ilExerciseMailNotification, and ilRegistrationMailNotification.

Definition at line 159 of file class.ilMailNotification.php.

References ilLanguageFactory\_getLanguageOfUser().

Referenced by ilMailSummaryNotification\send(), ilDiskQuotaSummaryNotification\send(), and ilCalendarMailNotification\send().

        {
                $this->language = ilLanguageFactory::_getLanguageOfUser($a_usr_id);
                $this->language->loadLanguageModule('mail');
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilMailNotification::initMail ( )

protected

Init mail.

Returns

Definition at line 329 of file class.ilMailNotification.php.

References getSender().

Referenced by getMail(), ilMailSummaryNotification\send(), ilRegistrationMailNotification\send(), ilCourseMembershipMailNotification\send(), ilGroupMembershipMailNotification\send(), ilDiskQuotaSummaryNotification\send(), ilExerciseMailNotification\send(), and ilCalendarMailNotification\send().

        {
                return $this->mail = new ilMail($this->getSender());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilMailNotification::send ( )

Send notifications.

Returns

Reimplemented in ilCalendarMailNotification, ilExerciseMailNotification, ilDiskQuotaSummaryNotification, ilCourseMembershipMailNotification, ilGroupMembershipMailNotification, ilRegistrationMailNotification, and ilMailSummaryNotification.

Definition at line 280 of file class.ilMailNotification.php.

References getType().

        {
                switch($this->getType())
                {
                        
                }
        }

Here is the call graph for this function:

ilMailNotification::sendMail	(	$a_rcp,
		$a_type,
		$a_parse_recipients = `true`
	)

Send Mail.

Parameters

array	recipients
array	mail type (one 'normal', 'system', 'email')

Returns

Definition at line 294 of file class.ilMailNotification.php.

References $error, $GLOBALS, $recipients, ilObjUser\_lookupLogin(), getBody(), getMail(), and getSubject().

Referenced by ilRegistrationMailNotification\send(), ilGroupMembershipMailNotification\send(), ilCourseMembershipMailNotification\send(), ilDiskQuotaSummaryNotification\send(), ilExerciseMailNotification\send(), and ilCalendarMailNotification\send().

        {
                $recipients = array();
                foreach($a_rcp as $rcp)
                {
                        if($a_parse_recipients)
                        {
                                $recipients[] = ilObjUser::_lookupLogin($rcp);
                        }
                        else
                        {
                                $recipients[] = $rcp;
                        }
                }
                $recipients = implode(',',$recipients);
                $error = $this->getMail()->sendMail(
                        $recipients,
                        '',
                        '',
                        $this->getSubject(),
                        $this->getBody(),
                        array(),
                        $a_type
                );
                if(strlen($error))
                {
                        $GLOBALS['ilLog']->write(__METHOD__.': '.$error);
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilMailNotification::setAdditionalInformation ( $a_info )

Additional information for creating notification mails.

Parameters

array $a_info

Returns

Definition at line 247 of file class.ilMailNotification.php.

        {
                $this->additional_info = $a_info;
        }

ilMailNotification::setBody ( $a_body )

protected

Set mail body.

Parameters

string $a_body

Returns

Definition at line 111 of file class.ilMailNotification.php.

Referenced by ilMailSummaryNotification\send(), ilRegistrationMailNotification\send(), ilGroupMembershipMailNotification\send(), ilCourseMembershipMailNotification\send(), ilDiskQuotaSummaryNotification\send(), ilExerciseMailNotification\send(), and ilCalendarMailNotification\send().

        {
                $this->body = $a_body;
        }

Here is the caller graph for this function:

ilMailNotification::setLanguage ( $a_language )

protected

A language.

Parameters

object $a_language

Returns

Definition at line 170 of file class.ilMailNotification.php.

Referenced by ilCalendarMailNotification\send().

        {
                $this->language = $a_language;
        }

Here is the caller graph for this function:

ilMailNotification::setObjId ( $a_obj_id )

set obj id

Returns

Definition at line 228 of file class.ilMailNotification.php.

        {
                $this->obj_id = $a_obj_id;
        }

ilMailNotification::setRecipients ( $a_rcp )

set mail recipients

Parameters

array $a_rcp user ids

Returns

Definition at line 140 of file class.ilMailNotification.php.

Referenced by ilDiskQuotaSummaryNotification\__construct(), and ilMailSummaryNotification\send().

        {
                $this->recipients = $a_rcp;
        }

Here is the caller graph for this function:

ilMailNotification::setRefId ( $a_id )

Set ref id.

Parameters

int $a_id

Returns

Definition at line 199 of file class.ilMailNotification.php.

References ilObject\_lookupObjId(), and ilObject\_lookupType().

        {
                $this->ref_id = $a_id;
                $this->obj_id = ilObject::_lookupObjId($this->ref_id);
                $this->obj_type = ilObject::_lookupType($this->obj_id);
        }

Here is the call graph for this function:

ilMailNotification::setSender ( $a_usr_id )

Set sender of mail.

Parameters

int $a_usr_id

Returns

Definition at line 73 of file class.ilMailNotification.php.

Referenced by __construct(), and ilCalendarMailNotification\__construct().

        {
                $this->sender = $a_usr_id;
        }

Here is the caller graph for this function:

ilMailNotification::setSubject ( $a_subject )

protected

Set mail subject.

Parameters

string $a_subject

Returns: string body

Definition at line 92 of file class.ilMailNotification.php.

Referenced by ilMailSummaryNotification\send(), ilRegistrationMailNotification\send(), ilGroupMembershipMailNotification\send(), ilCourseMembershipMailNotification\send(), ilDiskQuotaSummaryNotification\send(), ilExerciseMailNotification\send(), and ilCalendarMailNotification\send().

        {
                return $this->subject = $a_subject;
        }

Here is the caller graph for this function:

ilMailNotification::setType ( $a_type )

Set notification type.

Parameters

int $a_type

Returns

Definition at line 54 of file class.ilMailNotification.php.

        {
                $this->type = $a_type;
        }

ilMailNotification::userToString ( $a_usr_id )

protected

Utility function.

Parameters

int $a_usr_id

Returns

Definition at line 368 of file class.ilMailNotification.php.

References $name, and ilObjUser\_lookupName().

Referenced by ilCourseMembershipMailNotification\send(), and ilGroupMembershipMailNotification\send().

        {
                $name = ilObjUser::_lookupName($a_usr_id);
                return ($name['title'] ? $name['title'].' ' : '').
                        ($name['firstname'] ? $name['firstname'].' ' : '').
                        ($name['lastname'] ? $name['lastname'].' ' : '');
        }