ilRegistrationMailNotification Class Reference

Inheritance diagram for ilRegistrationMailNotification:

Collaboration diagram for ilRegistrationMailNotification:

Public Member Functions
	__construct ()
	Default constructor.
	send ()
	Parse and send mail.
Public Member Functions inherited from ilMailNotification
	__construct ($a_is_personal_workspace=false)
	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
	setAttachments ($a_att)
	Set attachments.
	getAttachments ()
	Get attachments.
	setLangModules (array $a_modules)
	Set lang modules.
	getUserLanguage ($a_usr_id)
	Get user language.
	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.
	sendMail ($a_rcp, $a_type, $a_parse_recipients=true)
	Send Mail.
	getBlockBorder ()
	Get (ascii) block border.

Data Fields
const	TYPE_NOTIFICATION_APPROVERS = 30
const	TYPE_NOTIFICATION_CONFIRMATION = 31
Data Fields inherited from ilMailNotification
const	SUBJECT_TITLE_LENGTH = 60

Protected Member Functions
	initLanguage ($a_usr_id)
	Add language module registration.
Protected Member Functions inherited from ilMailNotification
	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.
	initLanguageByIso2Code ($a_code= '')
	Init language by ISO2 code.
	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.
	isRefIdAccessible ($a_user_id, $a_ref_id, $a_permission="read")
	Check if ref id is accessible for user.

Additional Inherited Members
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

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

Version

$Id$

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

Constructor & Destructor Documentation

ilRegistrationMailNotification::__construct

(

)

Default constructor.

Returns

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

        {
                parent::__construct();
        }

Member Function Documentation

ilRegistrationMailNotification::initLanguage (   $a_usr_id )

protected

Add language module registration.

Parameters

object

$a_usr_id

Returns

Reimplemented from ilMailNotification.

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

References ilMailNotification\getLanguage().

Referenced by send().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilRegistrationMailNotification::send

(

)

Parse and send mail.

Returns

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

References ilLink\_getStaticLink(), ilMailNotification\appendBody(), ilMailNotification\getAdditionalInformation(), ilMailNotification\getLanguage(), ilMailNotification\getLanguageText(), ilMailNotification\getMail(), ilMailNotification\getRecipients(), ilMail\getSalutation(), ilMailNotification\getType(), initLanguage(), ilMailNotification\initMail(), ilMailNotification\sendMail(), ilMailNotification\setBody(), and ilMailNotification\setSubject().

        {
                switch($this->getType())
                {
                        case self::TYPE_NOTIFICATION_APPROVERS:
                                
                                foreach($this->getRecipients() as $rcp)
                                {
                                        $this->initLanguage($rcp);
                                        $this->initMail();
                                        $this->setSubject(
                                                $this->getLanguageText('reg_mail_new_user')
                                        );

                                        $this->setBody(ilMail::getSalutation($rcp,$this->getLanguage()));
                                        $this->appendBody("\n\n");
                                        
                                        $this->appendBody($this->getLanguageText('reg_mail_new_user_body'));
                                        $this->appendBody("\n\n");
                                        $this->appendBody($this->getLanguageText('reg_mail_body_profile'));
                                        
                                        $info = $this->getAdditionalInformation();
                                        
                                        $this->appendBody("\n\n");
                                        $this->appendBody($info['usr']->getProfileAsString($this->getLanguage()));

                                        $this->appendBody("\n\n");
                                        $this->appendBody($this->getLanguageText('reg_mail_body_reason'));

                                        $this->getMail()->appendInstallationSignature(true);
                                        $this->getMail()->enableSoap(false);
                                        $this->sendMail(array($rcp),array('system'));
                                }
                                break;

                        case self::TYPE_NOTIFICATION_CONFIRMATION:
                                
                                foreach($this->getRecipients() as $rcp)
                                {
                                        $this->initLanguage($rcp);
                                        $this->initMail();
                                        $this->setSubject(
                                                $this->getLanguageText('reg_mail_new_user_confirmation')
                                        );

                                        $this->setBody(ilMail::getSalutation($rcp,$this->getLanguage()));
                                        $this->appendBody("\n\n");
                                        
                                        $this->appendBody($this->getLanguageText('reg_mail_new_user_body'));
                                        $this->appendBody("\n\n");
                                        $this->appendBody($this->getLanguageText('reg_mail_body_profile'));
                                        
                                        $info = $this->getAdditionalInformation();
                                        
                                        $this->appendBody("\n\n");
                                        $this->appendBody($info['usr']->getProfileAsString($this->getLanguage()));

                                        $this->appendBody("\n\n");
                                        $this->appendBody($this->getLanguageText('reg_mail_body_confirmation'));                                
                                        $this->appendBody("\n"); // #4527
                                        include_once "Services/Link/classes/class.ilLink.php";
                                        $this->appendBody(ilLink::_getStaticLink($info['usr']->getId(), "usrf"));

                                        $this->appendBody("\n\n");
                                        $this->appendBody($this->getLanguageText('reg_mail_body_reason'));
                                        
                                        $this->getMail()->appendInstallationSignature(true);
                                        $this->getMail()->enableSoap(false);
                                        $this->sendMail(array($rcp),array('system'));
                                }
                                break;
                }
        }

Here is the call graph for this function:

Field Documentation

const ilRegistrationMailNotification::TYPE_NOTIFICATION_APPROVERS = 30

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

Referenced by ilAccountRegistrationGUI\__distributeMails().

const ilRegistrationMailNotification::TYPE_NOTIFICATION_CONFIRMATION = 31

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

Referenced by ilAccountRegistrationGUI\__distributeMails().

---

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

• Services/Registration/classes/class.ilRegistrationMailNotification.php