ilAccountRegistrationMail Class Reference

Class ilAccountRegistrationMail. More...

Inheritance diagram for ilAccountRegistrationMail:

Collaboration diagram for ilAccountRegistrationMail:

Public Member Functions
	__construct (ilRegistrationSettings $settings, ilLanguage $lng, ilLogger $logger)
	ilAccountRegistrationMail constructor. More...
	getMode ()
	withDirectRegistrationMode ()
	withEmailConfirmationRegistrationMode ()
	send (ilObjUser $user, $rawPassword='', $usedRegistrationCode=false)
Public Member Functions inherited from ilMimeMailNotification
	sendMimeMail ($a_rcp)
	setCurrentRecipient ($current_recipient)
	getCurrentRecipient ()
	setMimeMail ($mime_mail)
	getMimeMail ()
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_parse_recipients=true)
	getBlockBorder ()
	Get (ascii) block border. More...

Data Fields
const	MODE_DIRECT_REGISTRATION = 1
const	MODE_REGISTRATION_WITH_EMAIL_CONFIRMATION = 2
Data Fields inherited from ilMailNotification
const	SUBJECT_TITLE_LENGTH = 60

Private Member Functions
	isEmptyMailConfigurationData ($mailData)
	trySendingUserDefinedAccountMail (ilObjUser $user, $rawPassword)
	sendLanguageVariableBasedAccountMail (ilObjUser $user, $rawPassword, $usedRegistrationCode)

Private Attributes
	$settings
	$lng
	$logger
	$mode = self::MODE_DIRECT_REGISTRATION

Additional Inherited Members
Protected Member Functions inherited from ilMimeMailNotification
	initLanguageByIso2Code ($a_code='')
	initLanguage ($a_usr_id)
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 inherited from ilMimeMailNotification
	$mime_mail
	$current_recipient
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

Class ilAccountRegistrationMail.

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 8 of file class.ilAccountRegistrationMail.php.

Constructor & Destructor Documentation

__construct()

ilAccountRegistrationMail::__construct	(	ilRegistrationSettings	$settings,
		ilLanguage	$lng,
		ilLogger	$logger
	)

ilAccountRegistrationMail constructor.

Parameters

ilRegistrationSettings	$settings
ilLanguage	$lng
ilLogger	$logger

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

    {
        $this->settings = $settings;
        $this->lng = $lng;
        $this->logger = $logger;
 
        parent::__construct(false);
    }

References $lng, $logger, $settings, ILIAS\GlobalScreen\Provider\__construct(), and settings().

Here is the call graph for this function:

Member Function Documentation

getMode()

ilAccountRegistrationMail::getMode

(

)

Returns

int

Definition at line 43 of file class.ilAccountRegistrationMail.php.

    {
        return $this->mode;
    }

References $mode.

Referenced by sendLanguageVariableBasedAccountMail().

Here is the caller graph for this function:

isEmptyMailConfigurationData()

ilAccountRegistrationMail::isEmptyMailConfigurationData (   $mailData )

private

Parameters

$mailData

Returns

bool

Definition at line 74 of file class.ilAccountRegistrationMail.php.

    {
        return !(
            isset($mailData['body']) &&
            is_string($mailData['body']) &&
            $mailData['body'] !== '' &&
            isset($mailData['subject']) &&
            is_string($mailData['subject']) &&
            $mailData['subject'] !== ''
        );
    }

Referenced by trySendingUserDefinedAccountMail().

Here is the caller graph for this function:

send()

ilAccountRegistrationMail::send	(	ilObjUser	$user,
			$rawPassword = '',
			$usedRegistrationCode = false
	)

Parameters

ilObjUser	$user
string	$rawPassword
bool	$usedRegistrationCode

Definition at line 257 of file class.ilAccountRegistrationMail.php.

    {
        if (!$this->trySendingUserDefinedAccountMail($user, $rawPassword)) {
            $this->sendLanguageVariableBasedAccountMail($user, $rawPassword, $usedRegistrationCode);
        }
    }

References sendLanguageVariableBasedAccountMail(), and trySendingUserDefinedAccountMail().

Here is the call graph for this function:

sendLanguageVariableBasedAccountMail()

ilAccountRegistrationMail::sendLanguageVariableBasedAccountMail ( ilObjUser  $user,   $rawPassword,   $usedRegistrationCode  )

private

Parameters

ilObjUser	$user
string	$rawPassword
bool	$usedRegistrationCode

Definition at line 188 of file class.ilAccountRegistrationMail.php.

    {
        if (!$user->getEmail()) {
            $this->logger->debug(sprintf(
                "Missing email address, did not send account registration mail for user %s (id: %s) ...",
                $user->getLogin(),
                $user->getId()
            ));
            return;
        }
 
        $this->logger->debug(sprintf(
            "Sending language variable dependent welcome email to user %s (id: %s|language: %s) as fallback ...",
            $user->getLogin(),
            $user->getId(),
            $user->getLanguage()
        ));
 
        $this->initMimeMail();
 
        $this->initLanguageByIso2Code($user->getLanguage());
 
        $this->setSubject($this->language->txt('reg_mail_subject'));
 
        $this->setBody($this->language->txt('reg_mail_body_salutation') . ' ' . $user->getFullname() . ',');
        $this->appendBody("\n\n");
        $this->appendBody($this->language->txt('reg_mail_body_text1'));
        $this->appendBody("\n\n");
        $this->appendBody($this->language->txt('reg_mail_body_text2'));
        $this->appendBody("\n");
        $this->appendBody(ILIAS_HTTP_PATH . '/login.php?client_id=' . CLIENT_ID);
        $this->appendBody("\n");
        $this->appendBody($this->language->txt('login') . ': ' . $user->getLogin());
        $this->appendBody("\n");
 
        if ($this->settings->passwordGenerationEnabled()) {
            $this->appendBody($this->language->txt('passwd') . ': ' . $rawPassword);
            $this->appendBody("\n");
        }
 
        if ($this->getMode() === self::MODE_DIRECT_REGISTRATION) {
            if ($this->settings->getRegistrationType() == IL_REG_APPROVE && !$usedRegistrationCode) {
                $this->appendBody("\n");
                $this->appendBody($this->language->txt('reg_mail_body_pwd_generation'));
                $this->appendBody("\n\n");
            }
        } elseif ($this->getMode() === self::MODE_REGISTRATION_WITH_EMAIL_CONFIRMATION) {
            $this->appendBody("\n");
            $this->appendBody($this->language->txt('reg_mail_body_forgot_password_info'));
            $this->appendBody("\n\n");
        }
 
        $this->appendBody($this->language->txt('reg_mail_body_text3'));
        $this->appendBody("\n");
        $this->appendBody($user->getProfileAsString($this->language));
        $this->appendBody(ilMail::_getInstallationSignature());
 
        $this->sendMimeMail($user->getEmail());
 
        $this->logger->debug(sprintf(
            "Welcome email sent"
        ));
    }

References ilMail\_getInstallationSignature(), ilMailNotification\appendBody(), CLIENT_ID, ilObjUser\getEmail(), ilObjUser\getFullname(), ilObject\getId(), ilObjUser\getLanguage(), ilObjUser\getLogin(), getMode(), IL_REG_APPROVE, ilMimeMailNotification\initLanguageByIso2Code(), language(), ilMimeMailNotification\sendMimeMail(), ilMailNotification\setBody(), ilMailNotification\setSubject(), and settings().

Referenced by send().

Here is the call graph for this function:

Here is the caller graph for this function:

trySendingUserDefinedAccountMail()

ilAccountRegistrationMail::trySendingUserDefinedAccountMail ( ilObjUser  $user,   $rawPassword  )

private

Parameters

ilObjUser	$user
string	$rawPassword

Returns

bool

Definition at line 91 of file class.ilAccountRegistrationMail.php.

    {
        $trimStrings = function ($value) {
            if (is_string($value)) {
                $value = trim($value);
            }
 
            return $value;
        };
 
        $this->logger->debug(sprintf(
            "Trying to send configurable email dependent welcome email to user %s (id: %s|language: %s) ...",
            $user->getLogin(),
            $user->getId(),
            $user->getLanguage()
        ));
 
        $mailData = ilObjUserFolder::_lookupNewAccountMail($user->getLanguage());
        if (!is_array($mailData)) {
            $this->logger->debug(sprintf(
                "Did not find any email configuration for language '%s' at all, skipping attempt ...",
                $user->getLanguage()
            ));
            return false;
        }
 
        $mailData = array_map($trimStrings, $mailData);
 
        if ($this->isEmptyMailConfigurationData($mailData)) {
            $this->logger->debug(sprintf(
                "Either subject or email missing, trying to determine email configuration via default language: %s",
                $this->language->getDefaultLanguage()
            ));
 
            $mailData = ilObjUserFolder::_lookupNewAccountMail($this->language->getDefaultLanguage());
            if (!is_array($mailData)) {
                $this->logger->debug(sprintf(
                    "Did not find any email configuration for language '%s' at all, skipping attempt ...",
                    $this->language->getDefaultLanguage()
                ));
                return false;
            }
 
            $mailData = array_map($trimStrings, $mailData);
            if ($this->isEmptyMailConfigurationData($mailData)) {
                $this->logger->debug(sprintf(
                    "Did not find any valid email configuration, skipping attempt ..."
                ));
                return false;
            }
        }
 
        $accountMail = new ilAccountMail();
        $accountMail->setUser($user);
 
        if ($this->settings->passwordGenerationEnabled()) {
            $accountMail->setUserPassword($rawPassword);
        }
 
        if (isset($mailData['att_file'])) {
            $fs = new ilFSStorageUserFolder(USER_FOLDER_ID);
            $fs->create();
 
            $pathToFile = '/' . implode('/', array_map(function ($pathPart) {
                return trim($pathPart, '/');
            }, [
                $fs->getAbsolutePath(),
                $mailData['lang'],
            ]));
 
            $accountMail->addAttachment($pathToFile, $mailData['att_file']);
 
            $this->logger->debug(sprintf(
                "Attaching '%s' as '%s' ...",
                $pathToFile,
                $mailData['att_file']
            ));
        } else {
            $this->logger->debug(sprintf(
                "Not attachments configured for this email configuration ..."
            ));
        }
 
        $accountMail->send();
 
        $this->logger->debug(sprintf(
            "Welcome email sent"
        ));
 
        return true;
    }

References ilObjUserFolder\_lookupNewAccountMail(), ilObject\getId(), ilObjUser\getLanguage(), ilObjUser\getLogin(), isEmptyMailConfigurationData(), language(), settings(), and USER_FOLDER_ID.

Referenced by send().

Here is the call graph for this function:

Here is the caller graph for this function:

withDirectRegistrationMode()

ilAccountRegistrationMail::withDirectRegistrationMode

(

)

Returns

\ilAccountRegistrationMail

Definition at line 51 of file class.ilAccountRegistrationMail.php.

    {
        $clone = clone $this;
        $clone->mode = self::MODE_DIRECT_REGISTRATION;
 
        return $clone;
    }

References MODE_DIRECT_REGISTRATION.

withEmailConfirmationRegistrationMode()

ilAccountRegistrationMail::withEmailConfirmationRegistrationMode

(

)

Returns

\ilAccountRegistrationMail

Definition at line 62 of file class.ilAccountRegistrationMail.php.

    {
        $clone = clone $this;
        $clone->mode = self::MODE_REGISTRATION_WITH_EMAIL_CONFIRMATION;
 
        return $clone;
    }

References MODE_REGISTRATION_WITH_EMAIL_CONFIRMATION.

Field Documentation

$lng

ilAccountRegistrationMail::$lng

private

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

Referenced by __construct().

$logger

ilAccountRegistrationMail::$logger

private

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

Referenced by __construct().

$mode

ilAccountRegistrationMail::$mode = self::MODE_DIRECT_REGISTRATION

private

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

Referenced by getMode().

$settings

ilAccountRegistrationMail::$settings

private

Definition at line 14 of file class.ilAccountRegistrationMail.php.

Referenced by __construct().

MODE_DIRECT_REGISTRATION

const ilAccountRegistrationMail::MODE_DIRECT_REGISTRATION = 1

Definition at line 10 of file class.ilAccountRegistrationMail.php.

Referenced by withDirectRegistrationMode().

MODE_REGISTRATION_WITH_EMAIL_CONFIRMATION

const ilAccountRegistrationMail::MODE_REGISTRATION_WITH_EMAIL_CONFIRMATION = 2

Definition at line 11 of file class.ilAccountRegistrationMail.php.

Referenced by withEmailConfirmationRegistrationMode().

---

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

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